diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2019-03-05 07:58:18 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2019-03-08 07:42:54 +0100 |
commit | 828276b0814e519961b30506cad83ebc0065bcbb (patch) | |
tree | e93cf668ad005c3122707a40f9a4c0aab77813ba /bsps/powerpc | |
parent | bsps: Adjust bsp.h Doxygen groups (diff) | |
download | rtems-828276b0814e519961b30506cad83ebc0065bcbb.tar.bz2 |
bsps: Adjust shared Doxygen groups
Update #3706.
Diffstat (limited to 'bsps/powerpc')
-rw-r--r-- | bsps/powerpc/include/bsp/linker-symbols.h | 4 | ||||
-rw-r--r-- | bsps/powerpc/include/bsp/start.h | 4 | ||||
-rw-r--r-- | bsps/powerpc/include/bsp/tictac.h | 2 | ||||
-rw-r--r-- | bsps/powerpc/include/bsp/vectors.h | 8 | ||||
-rw-r--r-- | bsps/powerpc/include/bsp/vmeUniverse.h | 4 | ||||
-rw-r--r-- | bsps/powerpc/include/libcpu/powerpc-utility.h | 12 | ||||
-rw-r--r-- | bsps/powerpc/shared/cache/cache.c | 2 | ||||
-rw-r--r-- | bsps/powerpc/shared/clock/clock.c | 2 | ||||
-rw-r--r-- | bsps/powerpc/shared/doxygen.h | 14 | ||||
-rw-r--r-- | bsps/powerpc/shared/exceptions/ppc-code-copy.c | 2 | ||||
-rw-r--r-- | bsps/powerpc/shared/start/tictac.c | 2 | ||||
-rw-r--r-- | bsps/powerpc/shared/vme/doxygen.h | 6 |
12 files changed, 37 insertions, 25 deletions
diff --git a/bsps/powerpc/include/bsp/linker-symbols.h b/bsps/powerpc/include/bsp/linker-symbols.h index 06e5ef57a5..bd605664ad 100644 --- a/bsps/powerpc/include/bsp/linker-symbols.h +++ b/bsps/powerpc/include/bsp/linker-symbols.h @@ -30,9 +30,9 @@ extern "C" { #endif /* __cplusplus */ /** - * @defgroup powerpc_linker Linker Support + * @defgroup RTEMSBSPsPowerPCSharedLinker Linker Support * - * @ingroup powerpc_shared + * @ingroup RTEMSBSPsPowerPCShared * * @brief Linker support. * diff --git a/bsps/powerpc/include/bsp/start.h b/bsps/powerpc/include/bsp/start.h index ab718a87ee..b0c174cac0 100644 --- a/bsps/powerpc/include/bsp/start.h +++ b/bsps/powerpc/include/bsp/start.h @@ -30,9 +30,9 @@ extern "C" { #endif /* __cplusplus */ /** - * @defgroup powerpc_start PowerPC System Start + * @defgroup RTEMSBSPsPowerPCSharedStart PowerPC System Start * - * @ingroup powerpc_shared + * @ingroup RTEMSBSPsPowerPCShared * * @brief PowerPC low level start. * diff --git a/bsps/powerpc/include/bsp/tictac.h b/bsps/powerpc/include/bsp/tictac.h index c8acf98c3b..e66d63950c 100644 --- a/bsps/powerpc/include/bsp/tictac.h +++ b/bsps/powerpc/include/bsp/tictac.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup powerpc_shared + * @ingroup RTEMSBSPsPowerPCShared * * @brief Header file for tic-tac code. */ diff --git a/bsps/powerpc/include/bsp/vectors.h b/bsps/powerpc/include/bsp/vectors.h index eccf4f3738..894fe32074 100644 --- a/bsps/powerpc/include/bsp/vectors.h +++ b/bsps/powerpc/include/bsp/vectors.h @@ -46,7 +46,7 @@ extern "C" { /** * @defgroup ppc_exc PowerPC Exceptions * - * @brief XXX + * @ingroup RTEMSBSPsPowerPCShared * * @{ */ @@ -146,7 +146,7 @@ extern "C" { /** * @defgroup ppc_exc_frame PowerPC Exception Frame * - * @brief XXX + * @ingroup ppc_exc * * @{ */ @@ -188,7 +188,7 @@ extern "C" { #ifndef ASM /** - * @ingroup ppc_exc_frame + * @addtogroup ppc_exc_frame * * @{ */ @@ -198,7 +198,7 @@ typedef CPU_Exception_frame BSP_Exception_frame; /** @} */ /** - * @ingroup ppc_exc + * @addtogroup ppc_exc * * @{ */ diff --git a/bsps/powerpc/include/bsp/vmeUniverse.h b/bsps/powerpc/include/bsp/vmeUniverse.h index 7f68096e25..3b2de2b6ea 100644 --- a/bsps/powerpc/include/bsp/vmeUniverse.h +++ b/bsps/powerpc/include/bsp/vmeUniverse.h @@ -55,7 +55,9 @@ */ /** - * @defgroup shared_vmeuniverse Register definitions + * @defgroup shared_vmeuniverse_reg Register definitions + * + * @ingroup shared_vmeuniverse * * @brief all registers contents in PCI space are LITTLE ENDIAN */ diff --git a/bsps/powerpc/include/libcpu/powerpc-utility.h b/bsps/powerpc/include/libcpu/powerpc-utility.h index 931fb87d7c..f833c0e850 100644 --- a/bsps/powerpc/include/libcpu/powerpc-utility.h +++ b/bsps/powerpc/include/libcpu/powerpc-utility.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup powerpc_shared + * @ingroup RTEMSBSPsPowerPCShared * * @brief General purpose assembler macros, linker command file support and * some inline functions for direct register access. @@ -25,7 +25,13 @@ */ /** - * @defgroup powerpc_shared Shared PowerPC Code + * @defgroup RTEMSBSPsPowerPCSharedUtility PowerPC Utility Module + * + * @ingroup RTEMSBSPsPowerPCShared + * + * @brief PowerPC Utility Module. + * + * @{ */ #ifndef __LIBCPU_POWERPC_UTILITY_H @@ -1006,4 +1012,6 @@ void ShowBATS(void); } #endif +/** @} */ + #endif /* __LIBCPU_POWERPC_UTILITY_H */ diff --git a/bsps/powerpc/shared/cache/cache.c b/bsps/powerpc/shared/cache/cache.c index 902893b883..700e3c941a 100644 --- a/bsps/powerpc/shared/cache/cache.c +++ b/bsps/powerpc/shared/cache/cache.c @@ -1,7 +1,7 @@ /** * @file * - * #ingroup powerpc_shared + * #ingroup RTEMSBSPsPowerPCShared * * @brief Header file for the Cache Manager PowerPC support. */ diff --git a/bsps/powerpc/shared/clock/clock.c b/bsps/powerpc/shared/clock/clock.c index 431488a901..cfd77914ec 100644 --- a/bsps/powerpc/shared/clock/clock.c +++ b/bsps/powerpc/shared/clock/clock.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup powerpc_shared + * @ingroup RTEMSBSPsPowerPCShared * * @brief Source file for a clock driver. */ diff --git a/bsps/powerpc/shared/doxygen.h b/bsps/powerpc/shared/doxygen.h index 4f28235883..ca5c2b2a58 100644 --- a/bsps/powerpc/shared/doxygen.h +++ b/bsps/powerpc/shared/doxygen.h @@ -6,10 +6,10 @@ * @brief PowerPC Board Support Packages. */ - /** - * @defgroup powerpc_shared PowerPC Shared Modules - * - * @ingroup bsp_powerpc - * - * @brief PowerPc Shared Modules - */ +/** + * @defgroup RTEMSBSPsPowerPCShared Shared + * + * @ingroup RTEMSBSPsPowerPC + * + * @brief Shared Support for PowerPC Board Support Packages. + */ diff --git a/bsps/powerpc/shared/exceptions/ppc-code-copy.c b/bsps/powerpc/shared/exceptions/ppc-code-copy.c index 07f5234076..3171972185 100644 --- a/bsps/powerpc/shared/exceptions/ppc-code-copy.c +++ b/bsps/powerpc/shared/exceptions/ppc-code-copy.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup powerpc_shared + * @ingroup RTEMSBSPsPowerPCShared * * @brief Code copy implementation. */ diff --git a/bsps/powerpc/shared/start/tictac.c b/bsps/powerpc/shared/start/tictac.c index e6d0e779c2..6673c805f1 100644 --- a/bsps/powerpc/shared/start/tictac.c +++ b/bsps/powerpc/shared/start/tictac.c @@ -1,7 +1,7 @@ /** * @file * - * @ingroup powerpc_shared + * @ingroup RTEMSBSPsPowerPCShared * * @brief Source file for tic-tac code. */ diff --git a/bsps/powerpc/shared/vme/doxygen.h b/bsps/powerpc/shared/vme/doxygen.h index 2ccdeda9dd..c87183464b 100644 --- a/bsps/powerpc/shared/vme/doxygen.h +++ b/bsps/powerpc/shared/vme/doxygen.h @@ -1,5 +1,7 @@ /** - * @defgroup shared_vmeuniverse SHARED VMEUNIVERSE Modules + * @defgroup shared_vmeuniverse VME Universe Modules * - * @brief SHARED VMEUNIVERSE Modules + * @brief VME Universe Modules + * + * @ingroup RTEMSBSPsPowerPCShared */ |