diff --git a/sys/include/net/cord/config.h b/sys/include/net/cord/config.h index ef10d89398..56ed8b3e96 100644 --- a/sys/include/net/cord/config.h +++ b/sys/include/net/cord/config.h @@ -26,6 +26,11 @@ extern "C" { #endif +/** + * @defgroup net_cord_conf CoRE RD Client compile configurations + * @ingroup config + * @{ + */ /** * @brief Default lifetime in seconds (the default is 1 day) */ @@ -33,6 +38,14 @@ extern "C" { #define CONFIG_CORD_LT (86400UL) #endif +/** + * @brief Default client update interval (default is 3/4 the lifetime) + */ +#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) */ @@ -40,27 +53,30 @@ extern "C" { #define CORD_STARTUP_DELAY (3U) #endif -/** - * @brief Default client update interval (default is 3/4 the lifetime) - */ -#ifndef CONFIG_CORD_UPDATE_INTERVAL -#define CONFIG_CORD_UPDATE_INTERVAL ((CONFIG_CORD_LT / 4) * 3) -#endif - /** * @name Endpoint ID definition * * Per default, the endpoint ID (ep) is generated by concatenation of a user - * defined prefix (CORD_EP_PREFIX) and a locally unique ID (luid) encoded in + * defined prefix @ref CORD_EP_PREFIX and a locally unique ID (luid) encoded in * hexadecimal formatting with the given length of characters - * (CORD_EP_SUFFIX_LEN). + * @ref CORD_EP_SUFFIX_LEN. * * Alternatively, the endpoint ID value can be defined at compile time by - * assigning a string value to the CORD_ED macro. + * assigning a string value to the @ref CONFIG_CORD_EP macro. * * @{ */ #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 *