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