1 /*
2  *  Copyright (c) 2023, The OpenThread Authors.
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *  1. Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  *  2. Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *  3. Neither the name of the copyright holder nor the
13  *     names of its contributors may be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *  POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  * @brief
32  *  This file defines the Doxygen group structure for OpenThread documentation.
33  */
34 
35 /**
36  * @defgroup config                   Config Variables
37  * @brief
38  *   This module lists all OpenThread configuration variables.
39  *
40  * @{
41  *
42  * @defgroup config-announce-sender          Announce Sender
43  * @defgroup config-backbone-router          Backbone Router Services
44  * @defgroup config-border-agent             Border Agent
45  * @defgroup config-border-router            Border Router
46  * @defgroup config-border-routing           Border Routing Manager
47  * @defgroup config-channel-manager          Channel Manager
48  * @defgroup config-channel-monitor          Channel Monitor
49  * @defgroup config-child-supervision        Child Supervision
50  * @defgroup config-coap                     CoAP
51  * @defgroup config-commissioner             Commissioner
52  * @defgroup config-crypto                   Crypto Backend Library
53  * @defgroup config-dataset-updater          Dataset Updater
54  * @defgroup config-dhcpv6-client            DHCPv6 Client
55  * @defgroup config-dhcpv6-server            DHCPv6 Server
56  * @defgroup config-diag                     DIAG Service
57  * @defgroup config-dns-client               DNS Client
58  * @defgroup config-dns-dso                  DNS Stateful Operations
59  * @defgroup config-dnssd-server             DNS-SD Server
60  * @defgroup config-history-tracker          History Tracker
61  * @defgroup config-ip6                      IP6 Service
62  * @defgroup config-joiner                   Joiner
63  * @defgroup config-link-metrics-manager     Link Metrics Manager
64  * @defgroup config-link-quality             Link Quality
65  * @defgroup config-link-raw                 Link Raw Service
66  * @defgroup config-logging                  Logging Service
67  * @defgroup config-mac                      MAC
68  * @defgroup config-mesh-diag                Mesh Diagnostic
69  * @defgroup config-mesh-forwarder           Mesh Forwarder
70  * @defgroup config-misc                     Miscellaneous Constants
71  * @defgroup config-mle                      MLE Service
72  * @defgroup config-mdns                     Multicast DNS
73  * @defgroup config-nat64                    NAT64
74  * @defgroup config-netdata-publisher        Network Data Publisher
75  * @defgroup config-network-diagnostic       Network Diagnostics
76  * @defgroup config-parent-search            Parent Search
77  * @defgroup config-ping-sender              Ping Sender
78  * @defgroup config-platform                 Platform Specific Services
79  * @defgroup config-power-calibration        Power Calibration
80  * @defgroup config-radio-link               Radio Links
81  * @defgroup config-secure-transport         Secure Transport
82  * @defgroup config-sntp-client              SNTP Client
83  * @defgroup config-srp-client               SRP Client
84  * @defgroup config-srp-server               SRP Server
85  * @defgroup config-time-sync                Time Sync Service
86  * @defgroup config-tmf                      Thread Management Framework Service
87  * @defgroup config-trel                     TREL
88  *
89  * @}
90  *
91  */
92