[riot-notifications] [RIOT-OS/RIOT] gnrc_ipv6: make gnrc_netapi documentation more detailed (#10583)

Sebastian Meiling notifications at github.com
Mon Jan 7 08:44:48 CET 2019


smlng commented on this pull request.



> @@ -11,10 +11,63 @@
  * @ingroup     net_gnrc
  * @brief       GNRC's IPv6 implementation
  *
- * The IPv6 control thread understands messages of type
- *
- *  * @ref GNRC_NETAPI_MSG_TYPE_RCV, and
- *  * @ref GNRC_NETAPI_MSG_TYPE_SND,
+ * This module is for usage with the @ref net_gnrc_netapi
+ *
+ * # NETAPI command documentation

@miri64 ah okay, I think I get your point now ... I wasn't aware of the 6lo doc (at least that it is rather similar). However, what I saw was that the NETAPI module does not have such (extensive) documentation, hence I thought it might be misplaced here and should go in that header. 

TL;DR: leave as here, but might be nice to add some generic documentation/text on NETAPI in the respective header (later), too.

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/RIOT-OS/RIOT/pull/10583#discussion_r245569118
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190106/21546fe4/attachment-0001.html>


More information about the notifications mailing list