[riot-notifications] [RIOT-OS/RIOT] net/nanocoap: group functions in module doc (#10876)

Leandro Lanzieri notifications at github.com
Tue Apr 23 15:37:07 CEST 2019


leandrolanzieri commented on this pull request.

Just two minor comments, otherwise looks good. I like the grouping!

> - * @ingroup     net_nanocoap
+ * @defgroup    net_nanosock Nanocoap Sock
+ * @ingroup     net
+ * @brief       Synchronous sock based messaging with nanocoap
+ *
+ * nanocoap sock uses the nanocoap CoAP library to provide a synchronous
+ * interface to RIOT's sock networking API to read and write CoAP messages.
+ * For a server, nanocoap sock accepts a list of resource paths with callbacks
+ * for writing the response. For a client, nanocoap sock provides a function
+ * to send a request and waits for the server response.
+ *
+ * ## Server Operation ##
+ *
+ * See the nanocoap_server example, which is built on the nanocoap_server()
+ * function. A server must define an array of coap_resource_t resources for
+ * which it responds. See the declarations of `coap_resources` and

Would it be possible to add a link to `coap_resources` and `coap_resources_numof`?

> @@ -46,7 +46,8 @@
  * structs) ordered by the resource path, specifically the ASCII encoding of

I know this did not change in this PR, but we are touching the doc already so: Where it says "*Internally, gcoap depends on the nanocoap package for base level structs and functionality*" a link to nanocoap could be handy, as it is the first reference to it in the document.

Also, maybe change 'package' to module? as package usually refers to external packages in RIOT.

-- 
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/10876#pullrequestreview-229482653
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190423/c15e3f10/attachment.html>


More information about the notifications mailing list