[docs] create config variables list (openthread#9721)

doc/ot_config_doc.h

@@ -0,0 +1,89 @@
+/*
+ *  Copyright (c) 2023, The OpenThread Authors.
+ *  All rights reserved.
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions are met:
+ *  1. Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *  2. Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution.
+ *  3. Neither the name of the copyright holder nor the
+ *     names of its contributors may be used to endorse or promote products
+ *     derived from this software without specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ *  POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * @file
+ * @brief
+ *  This file defines the Doxygen group structure for OpenThread documentation.
+ */
+
+/**
+ * @defgroup config                   Config Variables
+ * @brief
+ *   This module lists all OpenThread configuration variables.
+ *
+ * @{
+ *
+ * @defgroup config-announce-sender          Announce Sender
+ * @defgroup config-backbone-router          Backbone Router Services
+ * @defgroup config-border-agent             Border Agent
+ * @defgroup config-border-router            Border Router
+ * @defgroup config-border-routing           Border Routing Manager
+ * @defgroup config-channel-manager          Channel Manager
+ * @defgroup config-channel-monitor          Channel Monitor
+ * @defgroup config-child-supervision        Child Supervision
+ * @defgroup config-coap         	     CoAP
+ * @defgroup config-commissioner	     Commissioner
+ * @defgroup config-crypto                   Crypto Backend Library
+ * @defgroup config-dataset-updater          Dataset Updater
+ * @defgroup config-dhcpv6-client            DHCPv6 Client
+ * @defgroup config-dhcpv6-server            DHCPv6 Server
+ * @defgroup config-diag                     DIAG Service
+ * @defgroup config-dns-client		     DNS Client
+ * @defgroup config-dns-dso	             DNS Stateful Operations
+ * @defgroup config-dnssd-server             DNS-SD Server
+ * @defgroup config-history-tracker          History Tracker
+ * @defgroup config-ip6                      IP6 Service
+ * @defgroup config-joiner                   Joiner
+ * @defgroup config-link-metrics-manager     Link Metrics Manager
+ * @defgroup config-link-quality             Link Quality
+ * @defgroup config-link-raw                 Link Raw Service
+ * @defgroup config-logging                  Logging Service
+ * @defgroup config-mac                      MAC
+ * @defgroup config-mesh-diag                Mesh Diagnostic
+ * @defgroup config-mesh-forwarder           Mesh Forwarder
+ * @defgroup config-misc                     Miscellaneous Constants
+ * @defgroup config-mle                      MLE Service
+ * @defgroup config-nat64                    NAT64
+ * @defgroup config-netdata-publisher        Network Data Publisher
+ * @defgroup config-network-diagnostic       Network Diagnostics
+ * @defgroup config-parent-search            Parent Search
+ * @defgroup config-ping-sender              Ping Sender
+ * @defgroup config-platform                 Platform Specific Services
+ * @defgroup config-power-calibration        Power Calibration
+ * @defgroup config-radio-link               Radio Links
+ * @defgroup config-secure-transport         Secure Transport
+ * @defgroup config-sntp-client              SNTP Client
+ * @defgroup config-srp-client               SRP Client
+ * @defgroup config-srp-server               SRP Server
+ * @defgroup config-time-sync                Time Sync Service
+ * @defgroup config-tmf                      Thread Management Framework Service
+ *
+ * @}
+ *
+ */

src/core/config/announce_sender.h

@@ -28,13 +28,23 @@
 
 /**
  * @file
- *   This file includes compile-time configurations for the DNS Client.
+ *   This file includes compile-time configurations for the Announce Sender.
  *
  */
 
 #ifndef CONFIG_ANNOUNCE_SENDER_H_
 #define CONFIG_ANNOUNCE_SENDER_H_
 
+/**
+ * @addtogroup config-announce-sender
+ *
+ * @brief
+ *   This module includes configuration variables for the Announce Sender.
+ *
+ * @{
+ *
+ */
+
 /**
  * @def OPENTHREAD_CONFIG_ANNOUNCE_SENDER_ENABLE
  *
@@ -90,4 +100,9 @@
 #define OPENTHREAD_CONFIG_ANNOUNCE_SENDER_JITTER_INTERVAL 500
 #endif
 
+/**
+ * @}
+ *
+ */
+
 #endif // CONFIG_ANNOUNCE_SENDER_H_

src/core/config/backbone_router.h

@@ -35,6 +35,16 @@
 #ifndef CONFIG_BACKBONE_ROUTER_H_
 #define CONFIG_BACKBONE_ROUTER_H_
 
+/**
+ * @addtogroup config-backbone-router
+ *
+ * @brief
+ *   This module includes configuration variables for Backbone Router services.
+ *
+ * @{
+ *
+ */
+
 /**
  * @def OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
  *
@@ -113,4 +123,9 @@
 #define OPENTHREAD_CONFIG_NDPROXY_TABLE_ENTRY_NUM 250
 #endif
 
+/**
+ * @}
+ *
+ */
+
 #endif // CONFIG_BACKBONE_ROUTER_H_

src/core/config/border_agent.h

@@ -35,6 +35,16 @@
 #ifndef CONFIG_BORDER_AGENT_H_
 #define CONFIG_BORDER_AGENT_H_
 
+/**
+ * @addtogroup config-border-agent
+ *
+ * @brief
+ *   This module includes configuration variables for Border Agent.
+ *
+ * @{
+ *
+ */
+
 /**
  * @def OPENTHREAD_CONFIG_BORDER_AGENT_ENABLE
  *
@@ -65,4 +75,9 @@
 #define OPENTHREAD_CONFIG_BORDER_AGENT_ID_ENABLE 0
 #endif
 
+/**
+ * @}
+ *
+ */
+
 #endif // CONFIG_BORDER_AGENT_H_

src/core/config/border_router.h

@@ -35,6 +35,16 @@
 #ifndef CONFIG_BORDER_ROUTER_H_
 #define CONFIG_BORDER_ROUTER_H_
 
+/**
+ * @addtogroup config-border-router
+ *
+ * @brief
+ *   This module includes configuration variables for Border Router services.
+ *
+ * @{
+ *
+ */
+
 #include <config/border_routing.h>
 
 /**
@@ -83,4 +93,9 @@
 #define OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE
 #endif
 
+/**
+ * @}
+ *
+ */
+
 #endif // CONFIG_BORDER_ROUTER_H_

src/core/config/border_routing.h

@@ -35,6 +35,16 @@
 #ifndef CONFIG_BORDER_ROUTING_H_
 #define CONFIG_BORDER_ROUTING_H_
 
+/**
+ * @addtogroup config-border-routing
+ *
+ * @brief
+ *   This module includes configuration variables for Border Routing Manager.
+ *
+ * @{
+ *
+ */
+
 /**
  * @def OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE
  *
@@ -162,4 +172,9 @@
 #define OPENTHREAD_CONFIG_BORDER_ROUTING_MOCK_PLAT_APIS_ENABLE 0
 #endif
 
+/**
+ * @}
+ *
+ */
+
 #endif // CONFIG_BORDER_ROUTING_H_

src/core/config/channel_manager.h

@@ -35,6 +35,16 @@
 #ifndef CONFIG_CHANNEL_MANAGER_H_
 #define CONFIG_CHANNEL_MANAGER_H_
 
+/**
+ * @addtogroup config-channel-manager
+ *
+ * @brief
+ *   This module includes configuration variables for Channel Manager.
+ *
+ * @{
+ *
+ */
+
 /**
  * @def OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE
  *
@@ -136,4 +146,9 @@
 #define OPENTHREAD_CONFIG_CHANNEL_MANAGER_CCA_FAILURE_THRESHOLD (0xffff * 14 / 100)
 #endif
 
+/**
+ * @}
+ *
+ */
+
 #endif // CONFIG_CHANNEL_MANAGER_H_

src/core/config/channel_monitor.h

@@ -35,6 +35,16 @@
 #ifndef CONFIG_CHANNEL_MONITOR_H_
 #define CONFIG_CHANNEL_MONITOR_H_
 
+/**
+ * @addtogroup config-channel-monitor
+ *
+ * @brief
+ *   This module includes configuration variables for Channel Monitor.
+ *
+ * @{
+ *
+ */
+
 /**
  * @def OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE
  *
@@ -92,4 +102,9 @@
 #define OPENTHREAD_CONFIG_CHANNEL_MONITOR_SAMPLE_WINDOW 960
 #endif
 
+/**
+ * @}
+ *
+ */
+
 #endif // CONFIG_CHANNEL_MONITOR_H_

src/core/config/child_supervision.h

@@ -35,6 +35,16 @@
 #ifndef CONFIG_CHILD_SUPERVISION_H_
 #define CONFIG_CHILD_SUPERVISION_H_
 
+/**
+ * @addtogroup config-child-supervision
+ *
+ * @brief
+ *   This module includes configuration variables for Child Supervision.
+ *
+ * @{
+ *
+ */
+
 /**
  * @def OPENTHREAD_CONFIG_CHILD_SUPERVISION_INTERVAL
  *
@@ -86,4 +96,9 @@
 #define OPENTHREAD_CONFIG_CHILD_SUPERVISION_OLDER_VERSION_CHILD_DEFAULT_INTERVAL 129
 #endif
 
+/**
+ * @}
+ *
+ */
+
 #endif // CONFIG_CHILD_SUPERVISION_H_

src/core/config/coap.h

@@ -35,6 +35,16 @@
 #ifndef CONFIG_COAP_H_
 #define CONFIG_COAP_H_
 
+/**
+ * @addtogroup config-coap
+ *
+ * @brief
+ *   This module includes configuration variables for CoAP.
+ *
+ * @{
+ *
+ */
+
 /**
  * @def OPENTHREAD_CONFIG_COAP_SERVER_MAX_CACHED_RESPONSES
  *
@@ -97,4 +107,9 @@
 #define OPENTHREAD_CONFIG_COAP_SECURE_API_ENABLE 0
 #endif
 
+/**
+ * @}
+ *
+ */
+
 #endif // CONFIG_COAP_H_

src/core/config/commissioner.h

@@ -35,6 +35,16 @@
 #ifndef CONFIG_COMMISSIONER_H_
 #define CONFIG_COMMISSIONER_H_
 
+/**
+ * @addtogroup config-commissioner
+ *
+ * @brief
+ *   This module includes configuration variables for the Commissioner.
+ *
+ * @{
+ *
+ */
+
 /**
  * @def OPENTHREAD_CONFIG_COMMISSIONER_ENABLE
  *
@@ -66,4 +76,9 @@
 #define OPENTHREAD_CONFIG_COMMISSIONER_JOINER_SESSION_TIMEOUT 30
 #endif
 
+/**
+ * @}
+ *
+ */
+
 #endif // CONFIG_COMMISSIONER_H_

src/core/config/crypto.h

@@ -29,6 +29,16 @@
 #ifndef CONFIG_CRYPTO_H_
 #define CONFIG_CRYPTO_H_
 
+/**
+ * @addtogroup config-crypto
+ *
+ * @brief
+ *   This module includes configuration variables for the Crypto Backend Library.
+ *
+ * @{
+ *
+ */
+
 /**
  * @def OPENTHREAD_CONFIG_CRYPTO_LIB
  *
@@ -95,4 +105,9 @@
 
 #endif // OPENTHREAD_CONFIG_CRYPTO_LIB == OPENTHREAD_CONFIG_CRYPTO_LIB_PLATFORM
 
+/**
+ * @}
+ *
+ */
+
 #endif // CONFIG_CRYPTO_H_