From 1cd19ba662f3c532fa82ee55a4b2b3194ae72469 Mon Sep 17 00:00:00 2001 From: Akshai M Date: Sat, 22 Aug 2020 16:40:10 +0530 Subject: [PATCH] net/skald : Update documentation --- sys/include/net/skald.h | 52 +++++++++++++++++++++++++++++++++++++---- 1 file changed, 47 insertions(+), 5 deletions(-) diff --git a/sys/include/net/skald.h b/sys/include/net/skald.h index 2670f55f0abba..ab893d5eff416 100644 --- a/sys/include/net/skald.h +++ b/sys/include/net/skald.h @@ -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