Skip to content

Commit

Permalink
net/skald : Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
akshaim committed Aug 26, 2020
1 parent 36a6875 commit 1cd19ba
Showing 1 changed file with 47 additions and 5 deletions.
52 changes: 47 additions & 5 deletions sys/include/net/skald.h
Original file line number Diff line number Diff line change
Expand Up @@ -55,28 +55,70 @@ extern "C" {
#endif

/**
* @brief Default static advertising interval
* @defgroup net_skald_conf Skald compile configurations
* @ingroup config
* @{
*/
/**
* @brief Advertising interval in microseconds
*/
#ifndef CONFIG_SKALD_INTERVAL
#define CONFIG_SKALD_INTERVAL (1 * US_PER_SEC)
#endif

/**
* @brief Configure advertising channels
* @brief Configure advertising channel 37
*
* Set CONFIG_ADV_CH_37_DISABLE to disable channel 37
*/
#ifdef DOXYGEN
#define CONFIG_ADV_CH_37_DISABLE
#endif

/**
* @brief Configure advertising channel 38
*
* Set CONFIG_ADV_CH_38_DISABLE to disable channel 38
*/
#ifndef CONFIG_ADV_CH_37_DISABLE
#ifdef DOXYGEN
#define CONFIG_ADV_CH_38_DISABLE
#endif

/**
* @brief Configure advertising channel 39
*
* Set CONFIG_ADV_CH_39_DISABLE to disable channel 39
*/
#ifdef DOXYGEN
#define CONFIG_ADV_CH_39_DISABLE
#endif
/** @} */

/**
* @brief Define advertising channel 37 if @ref CONFIG_ADV_CH_37_DISABLE is
* not set
*/
#if !defined(CONFIG_ADV_CH_37_DISABLE) || defined(DOXYGEN)
#define ADV_CH_37 37,
#else
#define ADV_CH_37
#endif

#ifndef CONFIG_ADV_CH_38_DISABLE
/**
* @brief Define advertising channel 38 if @ref CONFIG_ADV_CH_38_DISABLE is
* not set
*/
#if !defined(CONFIG_ADV_CH_38_DISABLE) || defined(DOXYGEN)
#define ADV_CH_38 38,
#else
#define ADV_CH_38
#endif

#ifndef CONFIG_ADV_CH_39_DISABLE
/**
* @brief Define advertising channel 39 if @ref CONFIG_ADV_CH_39_DISABLE is
* not set
*/
#if !defined(CONFIG_ADV_CH_39_DISABLE) || defined(DOXYGEN)
#define ADV_CH_39 39
#else
#define ADV_CH_39
Expand Down

0 comments on commit 1cd19ba

Please sign in to comment.