RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

Merge pull request #16812 from chrysn-pull-requests/cord-doc-discoverability

Browse Source 
net/cord doc: Usability fixes
This commit is contained in:
chrysn 2022-04-26 21:10:52 +02:00 committed by GitHub
commit 0a72fc9255
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
dist/tools/doccheck/exclude_patterns vendored
View File

@ -14286,7 +14286,6 @@ sys/include/net/coap\.h:[0-9]+: warning: Member COAP_TYPE_ACK \(macro definition
sys/include/net/coap\.h:[0-9]+: warning: Member COAP_TYPE_CON \(macro definition\) of group net_coap is not documented\.
sys/include/net/coap\.h:[0-9]+: warning: Member COAP_TYPE_NON \(macro definition\) of group net_coap is not documented\.
sys/include/net/coap\.h:[0-9]+: warning: Member COAP_TYPE_RST \(macro definition\) of group net_coap is not documented\.
sys/include/net/cord/config\.h:[0-9]+: warning: unbalanced grouping commands
sys/include/net/dhcpv6/client\.h:[0-9]+: warning: unbalanced grouping commands
sys/include/net/dhcpv6\.h:[0-9]+: warning: end of file with unbalanced grouping commands
sys/include/net/dns\.h:[0-9]+: warning: Member DNS_CLASS_IN \(macro definition\) of group net_dns is not documented\.

23
sys/include/net/cord/config.h
View File

@ -7,8 +7,9 @@
*/
/**
* @defgroup net_cord_config CoRE RD Endpoint and Lookup Client Configuration
* @defgroup net_cord_config CoRE RD Configuration
* @ingroup net_cord
* @ingroup config
* @brief Configuration options for CoRE RD endpoints and lookup clients
* @{
*
@ -26,11 +27,6 @@
extern "C" {
#endif
/**
* @defgroup net_cord_conf CoRE RD Client compile configurations
* @ingroup config
* @{
*/
/**
* @brief Default lifetime in seconds (the default is 1 day)
*/
@ -44,7 +40,6 @@ extern "C" {
#ifndef CONFIG_CORD_UPDATE_INTERVAL
#define CONFIG_CORD_UPDATE_INTERVAL ((CONFIG_CORD_LT / 4) * 3)
#endif
/** @} */
/**
* @brief Delay until the RD client starts to try registering (in seconds)
@ -69,13 +64,10 @@ extern "C" {
#ifndef CONFIG_CORD_EP
#ifdef DOXYGEN
/**
* @ingroup net_cord_conf
* @brief Endpoint ID definition
* @{
*/
#define CONFIG_CORD_EP "MyNewEpName" //defined for doxygen documentation only
#endif
/** @} */
/**
* @brief Number of generated hexadecimal characters added to the ep
@ -94,7 +86,15 @@ extern "C" {
/**
* @brief Extra query parameters added during registration
*
* Must be suitable for constructing a static array out of them.
* Must be suitable for constructing a static array out of them. Each item of
* the array is turned as a Uri-Query option. The [IANA RD Parameters subregistry]
* contains usable keys and their descriptions in entries that have an "R" in
* their "Use" column. Other keys can be used with known RD implementations.
*
* The `ep` and `lt` parameters are *not* to be set through this mechanism, but
* through @ref CONFIG_CORD_EP and @ref CONFIG_CORD_LT, respectively.
*
* [IANA RD Parameters subregistry]: https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#rd-parameters
*
* Example:
*
@ -105,7 +105,6 @@ extern "C" {
#ifdef DOXYGEN
#define CONFIG_CORD_EXTRAARGS
#endif
/** @} */
#ifdef __cplusplus
}