diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-02-14 16:48:07 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-02-16 08:27:09 +0100 |
| commit | bb465c8548aaf3c82c0eefb7b386a2fd0dda09f9 (patch) | |
| tree | 7273f350d6425336f91f26f3dd3a32eb0bfab7a6 /cpukit | |
| parent | libmisc/shell/main_edit.c: User cannot cut using ctrl e and x (diff) | |
| download | rtems-bb465c8548aaf3c82c0eefb7b386a2fd0dda09f9.tar.bz2 | |
doxygen: Add Doxygen files to a group
Update #3707.
Diffstat (limited to 'cpukit')
| -rw-r--r-- | cpukit/doxygen.h | 8 | ||||
| -rw-r--r-- | cpukit/doxygen/appl-config.h | 8 | ||||
| -rw-r--r-- | cpukit/doxygen/top-level-groups.h | 16 | ||||
| -rw-r--r-- | cpukit/include/rtems/rtems/mainpage.h | 5 |
4 files changed, 35 insertions, 2 deletions
diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h index a60d138c03..661955a501 100644 --- a/cpukit/doxygen.h +++ b/cpukit/doxygen.h @@ -1,4 +1,12 @@ /** + * @file + * + * @ingroup RTEMSImplDoxygen + * + * @brief This header file defines some Doxygen groups. + */ + +/** * @defgroup RTEMSAPIIO IO * * @ingroup RTEMSAPI diff --git a/cpukit/doxygen/appl-config.h b/cpukit/doxygen/appl-config.h index 5c76761453..2690b67d21 100644 --- a/cpukit/doxygen/appl-config.h +++ b/cpukit/doxygen/appl-config.h @@ -1,5 +1,13 @@ /* SPDX-License-Identifier: BSD-2-Clause */ +/** + * @file + * + * @ingroup RTEMSImplDoxygen + * + * @brief This header file documents the application configuration options. + */ + /* * Copyright (C) 2019, 2023 embedded brains GmbH (http://www.embedded-brains.de) * Copyright (C) 2010 Gedare Bloom diff --git a/cpukit/doxygen/top-level-groups.h b/cpukit/doxygen/top-level-groups.h index 8d38195f3e..8a439feee1 100644 --- a/cpukit/doxygen/top-level-groups.h +++ b/cpukit/doxygen/top-level-groups.h @@ -1,7 +1,15 @@ /* SPDX-License-Identifier: BSD-2-Clause */ +/** + * @file + * + * @ingroup RTEMSImplDoxygen + * + * @brief This header file defines high level Doxygen groups. + */ + /* - * Copyright (C) 2019, 2020 embedded brains GmbH (http://www.embedded-brains.de) + * Copyright (C) 2019, 2023 embedded brains GmbH (http://www.embedded-brains.de) * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions @@ -45,6 +53,12 @@ */ /** + * @defgroup RTEMSImplDoxygen Doxygen Support + * + * @ingroup RTEMSImpl + */ + +/** * @defgroup RTEMSTestSuites Test Suites * * @brief This group contains the test suites. diff --git a/cpukit/include/rtems/rtems/mainpage.h b/cpukit/include/rtems/rtems/mainpage.h index 313f4303c6..f168cc3395 100644 --- a/cpukit/include/rtems/rtems/mainpage.h +++ b/cpukit/include/rtems/rtems/mainpage.h @@ -3,7 +3,10 @@ /** * @file * - * This file exists to provide a top level description of RTEMS for Doxygen. + * @ingroup RTEMSImplDoxygen + * + * @brief This file exists to provide a top level description of RTEMS for + * Doxygen. */ /* |