cpukit/doxygen/top-level-groups.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSImplDoxygen
0007  *
0008  * @brief This header file defines high level Doxygen groups.
0009  */
0010
0011 /*
0012  * Copyright (C) 2019, 2023 embedded brains GmbH & Co. KG
0013  *
0014  * Redistribution and use in source and binary forms, with or without
0015  * modification, are permitted provided that the following conditions
0016  * are met:
0017  * 1. Redistributions of source code must retain the above copyright
0018  *    notice, this list of conditions and the following disclaimer.
0019  * 2. Redistributions in binary form must reproduce the above copyright
0020  *    notice, this list of conditions and the following disclaimer in the
0021  *    documentation and/or other materials provided with the distribution.
0022  *
0023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0024  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0025  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0026  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0027  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0028  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0029  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0030  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0031  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0032  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0033  * POSSIBILITY OF SUCH DAMAGE.
0034  */
0035
0036 /**
0037  * @defgroup RTEMSAPI API
0038  *
0039  * @brief This group contains the Application Programming Interfaces (APIs) of
0040  *   RTEMS.
0041  */
0042
0043 /**
0044  * @defgroup RTEMSAPISystemLibrary System Library
0045  *
0046  * @ingroup RTEMSAPI
0047  *
0048  * @brief This group contains the system library APIs of RTEMS.
0049  */
0050
0051 /**
0052  * @defgroup RTEMSDeviceDrivers Device Drivers
0053  *
0054  * @brief This group contains the device drivers.
0055  */
0056
0057 /**
0058  * @defgroup RTEMSDeviceConsole Console Drivers
0059  *
0060  * @ingroup RTEMSDeviceDrivers
0061  *
0062  * @brief This group contains the console drivers.
0063  */
0064
0065 /**
0066  * @defgroup RTEMSImpl Implementation
0067  *
0068  * @brief This group contains the RTEMS implementation components.
0069  */
0070
0071 /**
0072  * @defgroup RTEMSImplDoxygen Doxygen Support
0073  *
0074  * @ingroup RTEMSImpl
0075  */
0076
0077 /**
0078  * @defgroup RTEMSImplFreeBSDKernel FreeBSD Kernel Space Support
0079  *
0080  * @ingroup RTEMSImpl
0081  *
0082  * @brief This group contains the interfaces used by FreeBSD kernel space
0083  *   components ported to RTEMS.
0084  */
0085
0086 /**
0087  * @defgroup RTEMSTestSuites Test Suites
0088  *
0089  * @brief This group contains the test suites.
0090  */
0091
0092 /**
0093  * @defgroup RTEMSTestSuitesFilesystem Filesystem Test Suites
0094  *
0095  * @ingroup RTEMSTestSuites
0096  *
0097  * @brief This group contains the test suites related to filesystem tests.
0098  */
0099
0100 /**
0101  * @defgroup RTEMSTestSuitesUnit Unit Test Suites
0102  *
0103  * @ingroup RTEMSTestSuites
0104  *
0105  * @brief This group contains the test suites related to unit tests.
0106  */
0107
0108 /**
0109  * @defgroup RTEMSTestSuitesValidation Validation Test Suites
0110  *
0111  * @ingroup RTEMSTestSuites
0112  *
0113  * @brief This group contains the test suites related to validation tests.
0114  */