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