diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-02-13 15:50:32 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-07-21 07:55:31 +0200 |
commit | 5fb9ebfc9b36cb7af16dcfd75e00bc8e0ffd2b31 (patch) | |
tree | 55184b1d3f8d313542371e6824cbdbd7e0db4b91 /cpukit | |
parent | unit: Test unlimited objects configuration (diff) | |
download | rtems-5fb9ebfc9b36cb7af16dcfd75e00bc8e0ffd2b31.tar.bz2 |
doxgen: Document build system provided files
Update #3707.
Diffstat (limited to 'cpukit')
-rw-r--r-- | cpukit/doxygen/build.h | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/cpukit/doxygen/build.h b/cpukit/doxygen/build.h new file mode 100644 index 0000000000..696a6e1723 --- /dev/null +++ b/cpukit/doxygen/build.h @@ -0,0 +1,82 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSImplDoxygen + * + * @brief This header file defines build system related Doxygen items. + */ + +/* + * Copyright (C) 2023 embedded brains GmbH & Co. KG + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +/** + * @defgroup RTEMSImplBuild Build Options + * + * @ingroup RTEMSImpl + * + * @brief This group contains files generated by the build system. + */ + +/** + * @ingroup RTEMSImplBuild + * + * @file bsps/include/bspopts.h + * + * @brief This header file provides the BSP options definitions. + */ + +/** + * @ingroup RTEMSImplBuild + * + * @file cpukit/include/version-vc-key.h + * + * @brief This header file provides the version control key definitions. + */ + +/** + * @ingroup RTEMSImplBuild + * + * @file cpukit/include/config.h + * + * @brief This header file provides system configuration definitions. + */ + +/** + * @ingroup RTEMSImplBuild + * + * @file cpukit/include/rtems/testopts.h + * + * @brief This header file provides test program definitions. + */ + +/** + * @ingroup RTEMSImplBuild + * + * @file cpukit/include/rtems/score/cpuopts.h + * + * @brief This header file provides the CPU options definitions. + */ |