Merge pull request #10626 from jia200x/pr/ieee802154_conf

ieee802154: add config macros to config doc group
RIOT-OS · Dec 18, 2018 · d4fd607 · d4fd607
2 parents 321dc52 + a95bea6
commit d4fd607
Showing 1 changed file with 18 additions and 3 deletions.
diff --git a/sys/include/net/ieee802154.h b/sys/include/net/ieee802154.h
@@ -112,28 +112,43 @@ extern const uint8_t ieee802154_addr_bcast[IEEE802154_ADDR_BCAST_LEN];
 /** @} */
 
 /**
+ * @defgroup net_ieee802154_conf    IEEE802.15.4 compile configurations
+ * @ingroup  config
  * @{
- * @name    Default values
- * @brief   Default values for devices to choose
+ */
+/**
+ * @brief IEEE802.15.4 default sub-GHZ channel
  */
 #ifndef IEEE802154_DEFAULT_SUBGHZ_CHANNEL
 #define IEEE802154_DEFAULT_SUBGHZ_CHANNEL   (5U)
 #endif
 
+/**
+ * @brief IEEE802.15.4 default channel
+ */
 #ifndef IEEE802154_DEFAULT_CHANNEL
 #define IEEE802154_DEFAULT_CHANNEL          (26U)
 #endif
 
+/**
+ * @brief IEEE802.15.4 default sub-GHZ page
+ */
 #ifndef IEEE802154_DEFAULT_SUBGHZ_PAGE
 #define IEEE802154_DEFAULT_SUBGHZ_PAGE      (2U)
 #endif
 
+/**
+ * @brief IEEE802.15.4 default PANID
+ */
 #ifndef IEEE802154_DEFAULT_PANID
 #define IEEE802154_DEFAULT_PANID            (0x0023U)
 #endif
 
+/**
+ * @brief IEEE802.15.4 default TX power (in dBm)
+ */
 #ifndef IEEE802154_DEFAULT_TXPOWER
-#define IEEE802154_DEFAULT_TXPOWER          (0) /* in dBm */
+#define IEEE802154_DEFAULT_TXPOWER          (0)
 #endif
 /** @} */