[riot-notifications] [RIOT-OS/RIOT] net/cord doc: Usability fixes (#16812)

chrysn notifications at github.com
Sun Sep 5 10:44:16 CEST 2021


### Contribution description

The CoRD documentation had a few shortcomings, some of which doxygen already warned about, some from general usability, some because the text I added in #16113 was a bit too concise.

### Testing procedure

* Documentation builds without errors (even though some exclude patterns from #16779 were removed)
* All CoRD configuration macros are shown and searchable (for example, CONFIG_CORD_EP used to be shown but could not be found through the search;  CONFIG_CORD_EXTRAARGS was not shown before at all).
You can view, comment on, or merge this pull request online at:

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

-- Commit Summary --

  * net/cord doc: Rename configuration section
  * net/cord doc: Fix unbalanced grouping
  * net/cord doc: Fix parameter documentation
  * net/cord doc: Unify configuration documentation ...
  * net/cord doc: Fix Endpoint ID grouping
  * net/cord doc: Expand CONFIG_CORD_EXTRAARGS documentation
  * doxygen: Remove check exclusions for recent fixes

-- File Changes --

    M dist/tools/doccheck/exclude_patterns (2)
    M sys/include/net/cord/config.h (24)
    M sys/include/net/cord/ep_standalone.h (2)

-- Patch Links --

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


More information about the notifications mailing list