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

Ken Bannister notifications at github.com
Sat Jan 26 12:44:35 CET 2019


### Contribution description
It is difficult to use the nanocoap function documentation. There are now 52 public functions, not in alphabetic order. This PR organizes these functions into groups, sorts them within each group, and updates the module documentation to reference them. See the list below.

The groups also use a new name for the two APIs for writing a message: Buffer API and Packet API. Previously they were called the minimal API and struct-based API. I have struggled with these names for a while, but I think the new ones are simple and clear.

The groups are:
* Header attributes read/write
* Options read
* Options for Block
* Unclassified
* Packet Write API
* Buffer Write API
* Buffer Write Options
* gcoap specific

### Testing procedure
`make doc`

### Issues/PRs references
-none-
You can view, comment on, or merge this pull request online at:

  https://github.com/RIOT-OS/RIOT/pull/10876

-- Commit Summary --

  * net/nanocoap: create function groups in module doc
  * net/nanocoap: update write API names in module doc
  * net/nanocoap: reference new function sections

-- File Changes --

    M sys/include/net/nanocoap.h (1059)

-- Patch Links --

https://github.com/RIOT-OS/RIOT/pull/10876.patch
https://github.com/RIOT-OS/RIOT/pull/10876.diff

-- 
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
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190126/a9ea954f/attachment.html>


More information about the notifications mailing list