[riot-notifications] [RIOT-OS/RIOT] net/nanocoap: rebalance application vs. option API doc (#12231)

Ken Bannister notifications at github.com
Sat Sep 14 18:34:22 CEST 2019


### Contribution description

#12201 describes confusion on use of the nanocoap Packet and Buffer APIs for options relative to use of the nanocoap sock and gcoap application APIs. The issue is presently too much emphasis on the option APIs at the top of the documentation. This PR adds more emphasis on the application APIs, reduces the text on the option APIs at the top of the page, and describes the option API as a dependency of the application API. The goal is make it clear that the user need not independently decide which option API to use.

### Testing procedure

Build and compare the updated source documentation. There are changes to the nanocoap, nanocoap sock, and gcoap pages.

### Issues/PRs references

Implements requests in #12201. Also relates to #11488, which migrates application functionality from the base nanocoap library to nanocoap sock.

You can view, comment on, or merge this pull request online at:

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

-- Commit Summary --

  * net/nanocoap: doc emphasize application API
  * net/nanocoap: refactor Options API doc
  * net/gcoap: refactor Options API doc
  * net/nanocoap_sock: refactor Options API doc

-- File Changes --

    M sys/include/net/gcoap.h (3)
    M sys/include/net/nanocoap.h (40)
    M sys/include/net/nanocoap_sock.h (3)

-- Patch Links --

https://github.com/RIOT-OS/RIOT/pull/12231.patch
https://github.com/RIOT-OS/RIOT/pull/12231.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/12231
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190914/5d082a59/attachment.htm>


More information about the notifications mailing list