Skip to content

Commit

Permalink
sys/net/cord : Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
akshaim committed Sep 1, 2020
1 parent f8768b1 commit 08d56db
Showing 1 changed file with 25 additions and 9 deletions.
34 changes: 25 additions & 9 deletions sys/include/net/cord/config.h
Original file line number Diff line number Diff line change
Expand Up @@ -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)
*/
Expand All @@ -34,33 +39,44 @@ extern "C" {
#endif

/**
* @brief Delay until the RD client starts to try registering (in seconds)
* @brief Default client update interval (default is 3/4 the lifetime)
*/
#ifndef CORD_STARTUP_DELAY
#define CORD_STARTUP_DELAY (3U)
#ifndef CONFIG_CORD_UPDATE_INTERVAL
#define CONFIG_CORD_UPDATE_INTERVAL ((CONFIG_CORD_LT / 4) * 3)
#endif
/** @} */

/**
* @brief Default client update interval (default is 3/4 the lifetime)
* @brief Delay until the RD client starts to try registering (in seconds)
*/
#ifndef CONFIG_CORD_UPDATE_INTERVAL
#define CONFIG_CORD_UPDATE_INTERVAL ((CONFIG_CORD_LT / 4) * 3)
#ifndef CORD_STARTUP_DELAY
#define CORD_STARTUP_DELAY (3U)
#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 @ref Endpoint ID definition
* @{
*/
#define CONFIG_CORD_EP "MyNewEpName" //defined for doxygen documentation only
#endif
/** @} */

/**
* @brief Number of generated hexadecimal characters added to the ep
*
Expand Down

0 comments on commit 08d56db

Please sign in to comment.