mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2025-12-15 17:43:51 +01:00
Merge pull request #16812 from chrysn-pull-requests/cord-doc-discoverability
net/cord doc: Usability fixes
This commit is contained in:
commit
0a72fc9255
1
dist/tools/doccheck/exclude_patterns
vendored
1
dist/tools/doccheck/exclude_patterns
vendored
@ -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_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_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/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/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/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\.
|
sys/include/net/dns\.h:[0-9]+: warning: Member DNS_CLASS_IN \(macro definition\) of group net_dns is not documented\.
|
||||||
|
|||||||
@ -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 net_cord
|
||||||
|
* @ingroup config
|
||||||
* @brief Configuration options for CoRE RD endpoints and lookup clients
|
* @brief Configuration options for CoRE RD endpoints and lookup clients
|
||||||
* @{
|
* @{
|
||||||
*
|
*
|
||||||
@ -26,11 +27,6 @@
|
|||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
|
||||||
* @defgroup net_cord_conf CoRE RD Client compile configurations
|
|
||||||
* @ingroup config
|
|
||||||
* @{
|
|
||||||
*/
|
|
||||||
/**
|
/**
|
||||||
* @brief Default lifetime in seconds (the default is 1 day)
|
* @brief Default lifetime in seconds (the default is 1 day)
|
||||||
*/
|
*/
|
||||||
@ -44,7 +40,6 @@ extern "C" {
|
|||||||
#ifndef CONFIG_CORD_UPDATE_INTERVAL
|
#ifndef CONFIG_CORD_UPDATE_INTERVAL
|
||||||
#define CONFIG_CORD_UPDATE_INTERVAL ((CONFIG_CORD_LT / 4) * 3)
|
#define CONFIG_CORD_UPDATE_INTERVAL ((CONFIG_CORD_LT / 4) * 3)
|
||||||
#endif
|
#endif
|
||||||
/** @} */
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Delay until the RD client starts to try registering (in seconds)
|
* @brief Delay until the RD client starts to try registering (in seconds)
|
||||||
@ -69,13 +64,10 @@ extern "C" {
|
|||||||
#ifndef CONFIG_CORD_EP
|
#ifndef CONFIG_CORD_EP
|
||||||
#ifdef DOXYGEN
|
#ifdef DOXYGEN
|
||||||
/**
|
/**
|
||||||
* @ingroup net_cord_conf
|
|
||||||
* @brief Endpoint ID definition
|
* @brief Endpoint ID definition
|
||||||
* @{
|
|
||||||
*/
|
*/
|
||||||
#define CONFIG_CORD_EP "MyNewEpName" //defined for doxygen documentation only
|
#define CONFIG_CORD_EP "MyNewEpName" //defined for doxygen documentation only
|
||||||
#endif
|
#endif
|
||||||
/** @} */
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Number of generated hexadecimal characters added to the ep
|
* @brief Number of generated hexadecimal characters added to the ep
|
||||||
@ -94,7 +86,15 @@ extern "C" {
|
|||||||
/**
|
/**
|
||||||
* @brief Extra query parameters added during registration
|
* @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:
|
* Example:
|
||||||
*
|
*
|
||||||
@ -105,7 +105,6 @@ extern "C" {
|
|||||||
#ifdef DOXYGEN
|
#ifdef DOXYGEN
|
||||||
#define CONFIG_CORD_EXTRAARGS
|
#define CONFIG_CORD_EXTRAARGS
|
||||||
#endif
|
#endif
|
||||||
/** @} */
|
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
}
|
}
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user