1 /* 2 * Copyright (c) 2020, 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 api API 37 * @brief 38 * This module includes the application programming interface to the OpenThread stack. 39 * 40 * @{ 41 * 42 * @defgroup api-error Error 43 * 44 * @defgroup api-execution Execution 45 * 46 * @{ 47 * 48 * @defgroup api-instance Instance 49 * @defgroup api-tasklets Tasklets 50 * 51 * @} 52 * 53 * @defgroup api-net IPv6 Networking 54 * @{ 55 * 56 * @defgroup api-dns DNS 57 * @defgroup api-dnssd-server DNS-SD Server 58 * @defgroup api-icmp6 ICMPv6 59 * @defgroup api-ip6 IPv6 60 * @defgroup api-nat64 NAT64 61 * @defgroup api-srp SRP 62 * @defgroup api-ping-sender Ping Sender 63 * 64 * @defgroup api-tcp-group TCP 65 * 66 * @{ 67 * 68 * @defgroup api-tcp TCP 69 * @defgroup api-tcp-ext TCP Abstractions 70 * 71 * @} 72 * 73 * @defgroup api-udp-group UDP 74 * 75 * @{ 76 * 77 * @defgroup api-udp UDP 78 * @defgroup api-udp-forward UDP Forward 79 * 80 * @} 81 * 82 * @} 83 * 84 * @defgroup api-link Link 85 * 86 * @{ 87 * 88 * @defgroup api-link-link Link 89 * @defgroup api-link-metrics Link Metrics 90 * @defgroup api-link-raw Raw Link 91 * 92 * @} 93 * 94 * @defgroup api-message Message 95 * 96 * @defgroup api-multi-radio Multi Radio Link 97 * @defgroup api-trel TREL - Thread Stack 98 * 99 * @defgroup api-thread Thread 100 * 101 * @{ 102 * 103 * @defgroup api-backbone-router Backbone Router 104 * @defgroup api-border-agent Border Agent 105 * @defgroup api-border-router Border Router 106 * @defgroup api-border-routing Border Routing Manager 107 * @defgroup api-commissioner Commissioner 108 * @defgroup api-thread-general General 109 * @brief This module includes functions for all Thread roles. 110 * @defgroup api-joiner Joiner 111 * @defgroup api-operational-dataset Operational Dataset 112 * @brief Includes functions for the Operational Dataset API. 113 * @defgroup api-thread-router Router/Leader 114 * @brief This module includes functions for Thread Routers and Leaders. 115 * @defgroup api-server Server 116 * 117 * @} 118 * 119 * @defgroup api-addons Add-Ons 120 * 121 * @{ 122 * 123 * @defgroup api-channel-manager Channel Manager 124 * @defgroup api-channel-monitor Channel Monitoring 125 * @defgroup api-child-supervision Child Supervision 126 * @defgroup api-coap-group CoAP 127 * 128 * @{ 129 * 130 * @defgroup api-coap CoAP 131 * @defgroup api-coap-secure CoAP Secure 132 * 133 * @} 134 * 135 * @defgroup api-cli Command Line Interface 136 * @defgroup api-crypto Crypto - Thread Stack 137 * @defgroup api-factory-diagnostics Factory Diagnostics - Thread Stack 138 * @defgroup api-heap Heap 139 * @defgroup api-history-tracker History Tracker 140 * @defgroup api-jam-detection Jam Detection 141 * @defgroup api-logging Logging - Thread Stack 142 * @defgroup api-mesh-diag Mesh Diagnostics 143 * @defgroup api-ncp Network Co-Processor 144 * @defgroup api-network-time Network Time Synchronization 145 * @defgroup api-radio Radio Statistics 146 * @defgroup api-random-group Random Number Generator 147 * 148 * @{ 149 * 150 * @defgroup api-random-crypto RNG Cryptographic 151 * @defgroup api-random-non-crypto RNG Non-cryptographic 152 * 153 * @} 154 * 155 * @defgroup api-sntp SNTP 156 * 157 * @} 158 * 159 * @} 160 * 161 */ 162 163 /** 164 * @defgroup platform Platform Abstraction 165 * @brief 166 * This module includes the platform abstraction used by the OpenThread stack. 167 * 168 * @{ 169 * 170 * @defgroup plat-alarm Alarm 171 * @defgroup plat-crypto Crypto - Platform 172 * @defgroup plat-dns DNS - Platform 173 * @defgroup plat-entropy Entropy 174 * @defgroup plat-factory-diagnostics Factory Diagnostics - Platform 175 * @defgroup plat-logging Logging - Platform 176 * @defgroup plat-memory Memory 177 * @defgroup plat-messagepool Message Pool 178 * @defgroup plat-misc Miscellaneous 179 * @defgroup plat-otns Network Simulator 180 * @defgroup plat-radio Radio 181 * @defgroup plat-settings Settings 182 * @defgroup plat-spi-slave SPI Slave 183 * @defgroup plat-time Time Service 184 * @defgroup plat-toolchain Toolchain 185 * @defgroup plat-trel TREL - Platform 186 * @defgroup plat-infra-if Infrastructure Interface 187 * 188 * @} 189 * 190 */ 191
