diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2019-02-26 15:44:50 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2019-03-04 07:51:38 +0100 |
| commit | 212663bede5c183df679560f90f0ad92f995de9b (patch) | |
| tree | 8b857aefe33e474b998468dc7157420a0a9f31ca /bsps/shared | |
| parent | Update Doxyfile to Doxygen 1.8.15 (diff) | |
| download | rtems-212663bede5c183df679560f90f0ad92f995de9b.tar.bz2 | |
bsps: Adjust architecture Doxygen groups
- Use CamelCase as it is not used in our C code. Enables simple search and
replace.
- Prefix with "RTEMS" to aid deployment and integration. It aids
searching and sorting.
Update #3706.
Diffstat (limited to 'bsps/shared')
| -rw-r--r-- | bsps/shared/dev/clock/clockimpl.h | 2 | ||||
| -rw-r--r-- | bsps/shared/doxygen.h | 15 | ||||
| -rw-r--r-- | bsps/shared/start/bootcard.c | 15 | ||||
| -rw-r--r-- | bsps/shared/start/stackalloc.c | 2 |
4 files changed, 10 insertions, 24 deletions
diff --git a/bsps/shared/dev/clock/clockimpl.h b/bsps/shared/dev/clock/clockimpl.h index f3a41b1480..7913cde28c 100644 --- a/bsps/shared/dev/clock/clockimpl.h +++ b/bsps/shared/dev/clock/clockimpl.h @@ -32,7 +32,7 @@ /** * @defgroup bsp_clock Clock Support * - * @ingroup bsp_shared + * @ingroup RTEMSBSPsShared * * @brief Clock support * diff --git a/bsps/shared/doxygen.h b/bsps/shared/doxygen.h index bbc7bb972f..538ed9e8b1 100644 --- a/bsps/shared/doxygen.h +++ b/bsps/shared/doxygen.h @@ -1,15 +1,14 @@ /** - * @defgroup bsp_shared SHARED + * @defgroup RTEMSBSPs Board Support Packages * - * @ingroup bsp_kit - * - * @brief SHARED Board Support Packages + * @brief Board Support Packages and Support Modules + * (BSPs). */ /** - * @defgroup shared_tod SHARED TOD Modules + * @defgroup RTEMSBSPsShared Shared * - * @ingroup bsp_shared + * @ingroup RTEMSBSPs * - * @brief SHARED TOD Modules - */
\ No newline at end of file + * @brief Shared Support for Board Support Packages + */ diff --git a/bsps/shared/start/bootcard.c b/bsps/shared/start/bootcard.c index 83030f29ba..542785bd83 100644 --- a/bsps/shared/start/bootcard.c +++ b/bsps/shared/start/bootcard.c @@ -1,20 +1,7 @@ /** * @file * - * @ingroup bsp_bootcard - * - * @brief Standard system startup. - * - * This is the C entry point for ALL RTEMS BSPs. It is invoked - * from the assembly language initialization file usually called - * start.S. It provides the framework for the BSP initialization - * sequence. For the basic flow of initialization see RTEMS C User's Guide, - * Initialization Manager. - * - * This style of initialization ensures that the C++ global - * constructors are executed after RTEMS is initialized. - * Thanks to Chris Johns <cjohns@plessey.com.au> for the idea - * to move C++ global constructors into the first task. + * @ingroup RTEMSBSPsSharedStartup */ /* diff --git a/bsps/shared/start/stackalloc.c b/bsps/shared/start/stackalloc.c index 3e3b83e95e..f7cf7be0f1 100644 --- a/bsps/shared/start/stackalloc.c +++ b/bsps/shared/start/stackalloc.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup bsp_shared + * @ingroup bsp_stack * * @brief Stack initialization, allocation and free functions. */ |