From 296c74e643d931dfde12ac4cb177cdbb0fb46ee4 Mon Sep 17 00:00:00 2001 From: Daniel Ramirez Date: Mon, 9 Dec 2013 13:37:48 -0600 Subject: doxygen: refactored doxygen in libbsp to illustrate new rule set --- c/src/lib/libbsp/arm/lpc24xx/include/bsp.h | 2 +- c/src/lib/libbsp/arm/raspberrypi/include/bsp.h | 2 +- c/src/lib/libbsp/arm/shared/doxygen.h | 15 +++++++++++++++ c/src/lib/libbsp/arm/shared/include/linker-symbols.h | 6 +++--- c/src/lib/libbsp/arm/shared/include/start.h | 10 +--------- c/src/lib/libbsp/powerpc/shared/doxygen.h | 15 +++++++++++++++ c/src/lib/libbsp/powerpc/shared/include/linker-symbols.h | 6 +++--- c/src/lib/libbsp/powerpc/shared/include/start.h | 8 ++++---- c/src/lib/libbsp/shared/clockdrv_shell.h | 2 +- c/src/lib/libbsp/shared/doxygen.h | 13 +++++++++++++ c/src/lib/libbsp/shared/include/bootcard.h | 10 ++-------- c/src/lib/libbsp/shared/include/irq-generic.h | 2 +- c/src/lib/libbsp/shared/include/stackalloc.h | 2 +- c/src/lib/libbsp/sparc/erc32/include/bsp.h | 14 +++++++++++--- c/src/lib/libbsp/sparc/leon2/include/bsp.h | 15 ++++++++++++--- c/src/lib/libbsp/sparc/leon3/include/bsp.h | 15 ++++++++++++--- c/src/lib/libbsp/sparc/shared/doxygen.h | 15 +++++++++++++++ 17 files changed, 111 insertions(+), 41 deletions(-) create mode 100644 c/src/lib/libbsp/arm/shared/doxygen.h create mode 100644 c/src/lib/libbsp/powerpc/shared/doxygen.h create mode 100644 c/src/lib/libbsp/shared/doxygen.h create mode 100644 c/src/lib/libbsp/sparc/shared/doxygen.h (limited to 'c/src') diff --git a/c/src/lib/libbsp/arm/lpc24xx/include/bsp.h b/c/src/lib/libbsp/arm/lpc24xx/include/bsp.h index a0726a735d..15dc1109b3 100644 --- a/c/src/lib/libbsp/arm/lpc24xx/include/bsp.h +++ b/c/src/lib/libbsp/arm/lpc24xx/include/bsp.h @@ -56,7 +56,7 @@ struct rtems_bsdnet_ifconfig; /** * @defgroup lpc24xx LPC24XX Support * - * @ingroup bsp_kit + * @ingroup bsp_arm * * @brief LPC24XX support package. * diff --git a/c/src/lib/libbsp/arm/raspberrypi/include/bsp.h b/c/src/lib/libbsp/arm/raspberrypi/include/bsp.h index fa8c016674..8836264de9 100644 --- a/c/src/lib/libbsp/arm/raspberrypi/include/bsp.h +++ b/c/src/lib/libbsp/arm/raspberrypi/include/bsp.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup raspberrypi + * @ingroup arm_raspberrypi * * @brief Global BSP definitions. */ diff --git a/c/src/lib/libbsp/arm/shared/doxygen.h b/c/src/lib/libbsp/arm/shared/doxygen.h new file mode 100644 index 0000000000..83035100d8 --- /dev/null +++ b/c/src/lib/libbsp/arm/shared/doxygen.h @@ -0,0 +1,15 @@ + /** + * @defgroup bsp_arm ARM + * + * @ingroup bsp_kit + * + * @brief ARM Board Support Packages + */ + + /** + * @defgroup arm_shared ARM Shared Modules + * + * @ingroup bsp_arm + * + * @brief ARM Shared Modules + */ diff --git a/c/src/lib/libbsp/arm/shared/include/linker-symbols.h b/c/src/lib/libbsp/arm/shared/include/linker-symbols.h index 57af053201..0d69411039 100644 --- a/c/src/lib/libbsp/arm/shared/include/linker-symbols.h +++ b/c/src/lib/libbsp/arm/shared/include/linker-symbols.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup bsp_linker + * @ingroup arm_linker * * @brief Symbols defined in linker command base file. */ @@ -28,9 +28,9 @@ extern "C" { #endif /* __cplusplus */ /** - * @defgroup bsp_linker Linker Support + * @defgroup arm_linker Linker Support * - * @ingroup bsp_kit + * @ingroup arm_shared * * @brief Linker support. * diff --git a/c/src/lib/libbsp/arm/shared/include/start.h b/c/src/lib/libbsp/arm/shared/include/start.h index 99fa774663..933027181d 100644 --- a/c/src/lib/libbsp/arm/shared/include/start.h +++ b/c/src/lib/libbsp/arm/shared/include/start.h @@ -34,7 +34,7 @@ extern "C" { /** * @defgroup arm_start System Start * - * @ingroup bsp_arm + * @ingroup arm_shared * * @brief ARM system low level start. * @@ -140,11 +140,3 @@ BSP_START_TEXT_SECTION static inline void bsp_start_clear_bss(void) #endif /* __cplusplus */ #endif /* LIBBSP_ARM_SHARED_START_H */ - -/** - * @defgroup bsp_arm ARM - * - * @ingroup bsp_kit - * - * @brief ARM Board Support Packages. - */ diff --git a/c/src/lib/libbsp/powerpc/shared/doxygen.h b/c/src/lib/libbsp/powerpc/shared/doxygen.h new file mode 100644 index 0000000000..30c616e5d4 --- /dev/null +++ b/c/src/lib/libbsp/powerpc/shared/doxygen.h @@ -0,0 +1,15 @@ + /** + * @defgroup bsp_powerpc PowerPC + * + * @ingroup bsp_kit + * + * @brief PowerPC Board Support Packages + */ + + /** + * @defgroup powerpc_shared PowerPC Shared Modules + * + * @ingroup bsp_powerpc + * + * @brief PowerPc Shared Modules + */ diff --git a/c/src/lib/libbsp/powerpc/shared/include/linker-symbols.h b/c/src/lib/libbsp/powerpc/shared/include/linker-symbols.h index 77337ade26..09f8e12905 100644 --- a/c/src/lib/libbsp/powerpc/shared/include/linker-symbols.h +++ b/c/src/lib/libbsp/powerpc/shared/include/linker-symbols.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup bsp_linker + * @ingroup powerpc_linker * * @brief Symbols defined in linker command base file. */ @@ -30,9 +30,9 @@ extern "C" { #endif /* __cplusplus */ /** - * @defgroup bsp_linker Linker Support + * @defgroup powerpc_linker Linker Support * - * @ingroup bsp_kit + * @ingroup powerpc_shared * * @brief Linker support. * diff --git a/c/src/lib/libbsp/powerpc/shared/include/start.h b/c/src/lib/libbsp/powerpc/shared/include/start.h index bb1d412a2e..5c004dd9c6 100644 --- a/c/src/lib/libbsp/powerpc/shared/include/start.h +++ b/c/src/lib/libbsp/powerpc/shared/include/start.h @@ -1,7 +1,7 @@ /** * @file * - * @ingroup bsp_start + * @ingroup powerpc_start * * @brief System low level start. */ @@ -30,11 +30,11 @@ extern "C" { #endif /* __cplusplus */ /** - * @defgroup bsp_start System Start + * @defgroup powerpc_start PowerPC System Start * - * @ingroup bsp_kit + * @ingroup powerpc_shared * - * @brief System low level start. + * @brief PowerPC low level start. * * @{ */ diff --git a/c/src/lib/libbsp/shared/clockdrv_shell.h b/c/src/lib/libbsp/shared/clockdrv_shell.h index 1fa5564bc9..9e8c61fff9 100644 --- a/c/src/lib/libbsp/shared/clockdrv_shell.h +++ b/c/src/lib/libbsp/shared/clockdrv_shell.h @@ -22,7 +22,7 @@ /** * @defgroup bsp_clock Clock Support * - * @ingroup bsp_kit + * @ingroup bsp_shared * * @brief Clock support * diff --git a/c/src/lib/libbsp/shared/doxygen.h b/c/src/lib/libbsp/shared/doxygen.h new file mode 100644 index 0000000000..a552b25f86 --- /dev/null +++ b/c/src/lib/libbsp/shared/doxygen.h @@ -0,0 +1,13 @@ + /** + * @defgroup bsp_kit Board Support Packages + * + * @brief Board Support Packages + */ + + /** + * @defgroup bsp_shared Shared Modules + * + * @ingroup bsp_kit + * + * @brief BSP Shared Modules + */ diff --git a/c/src/lib/libbsp/shared/include/bootcard.h b/c/src/lib/libbsp/shared/include/bootcard.h index 688e8488f4..b607fe3dc6 100644 --- a/c/src/lib/libbsp/shared/include/bootcard.h +++ b/c/src/lib/libbsp/shared/include/bootcard.h @@ -20,12 +20,6 @@ * http://www.rtems.com/license/LICENSE. */ -/** - * @defgroup bsp_kit Board Support Package - * - * @brief Board support package dependent code. - */ - #ifndef LIBBSP_SHARED_BOOTCARD_H #define LIBBSP_SHARED_BOOTCARD_H @@ -43,9 +37,9 @@ extern "C" { #endif /* __cplusplus */ /** - * @defgroup bsp_bootcard Bootcard + * @defgroup shared_bootcard Bootcard * - * @ingroup bsp_kit + * @ingroup bsp_shared * * @brief Standard system startup. * diff --git a/c/src/lib/libbsp/shared/include/irq-generic.h b/c/src/lib/libbsp/shared/include/irq-generic.h index a703c69e9d..329b120b3c 100644 --- a/c/src/lib/libbsp/shared/include/irq-generic.h +++ b/c/src/lib/libbsp/shared/include/irq-generic.h @@ -90,7 +90,7 @@ static inline rtems_vector_number bsp_interrupt_handler_index( /** * @defgroup bsp_interrupt BSP Interrupt Support * - * @ingroup rtems_interrupt_extension + * @ingroup bsp_shared * * @brief Generic BSP Interrupt Support * diff --git a/c/src/lib/libbsp/shared/include/stackalloc.h b/c/src/lib/libbsp/shared/include/stackalloc.h index 6ed898fa65..7fd1be6420 100644 --- a/c/src/lib/libbsp/shared/include/stackalloc.h +++ b/c/src/lib/libbsp/shared/include/stackalloc.h @@ -33,7 +33,7 @@ extern "C" { /** * @defgroup bsp_stack Task Stack Allocator * - * @ingroup bsp_kit + * @ingroup bsp_shared * * @brief Task stack initialization, allocation and free functions. * diff --git a/c/src/lib/libbsp/sparc/erc32/include/bsp.h b/c/src/lib/libbsp/sparc/erc32/include/bsp.h index 289787f590..4fc6414a1b 100644 --- a/c/src/lib/libbsp/sparc/erc32/include/bsp.h +++ b/c/src/lib/libbsp/sparc/erc32/include/bsp.h @@ -1,9 +1,9 @@ /** * @file - * @ingroup sparc_bsp - * @defgroup sparc_erc32 SPARC ERC32 + * * @ingroup sparc_erc32 - * @brief SPARC ERC32 BSP + * + * @brief Global BSP Definitions. */ /* bsp.h @@ -42,6 +42,14 @@ extern "C" { #include #include +/** + * @defgroup sparc_erc32 ERC32 Support + * + * @ingroup bsp_sparc + * + * @brief ERC32 Support Package + */ + /* * BSP provides its own Idle thread body */ diff --git a/c/src/lib/libbsp/sparc/leon2/include/bsp.h b/c/src/lib/libbsp/sparc/leon2/include/bsp.h index f8ec0e509b..851861bafa 100644 --- a/c/src/lib/libbsp/sparc/leon2/include/bsp.h +++ b/c/src/lib/libbsp/sparc/leon2/include/bsp.h @@ -1,9 +1,9 @@ /** * @file - * @ingroup sparc_bsp - * @defgroup sparc_leon2 SPARC Leon2 + * * @ingroup sparc_leon2 - * @brief Sparc Leon2 BSP + * + * @brief Global BSP Definitions. */ /* bsp.h @@ -41,6 +41,15 @@ extern "C" { #include #include +/** + * @defgroup sparc_leon2 LEON2 Support + * + * @ingroup bsp_sparc + * + * @brief LEON2 Support Package + * + */ + /* SPARC CPU variant: LEON2 */ #define LEON2 1 diff --git a/c/src/lib/libbsp/sparc/leon3/include/bsp.h b/c/src/lib/libbsp/sparc/leon3/include/bsp.h index 8c7160c6cf..b0a17305af 100644 --- a/c/src/lib/libbsp/sparc/leon3/include/bsp.h +++ b/c/src/lib/libbsp/sparc/leon3/include/bsp.h @@ -1,9 +1,9 @@ /** * @file - * @ingroup sparc_bsp - * @defgroup sparc_leon3 SPARC LEON3 + * * @ingroup sparc_leon3 - * @brief SPARC LEON3 BSP + * + * @brief Global BSP Definitions. */ /* bsp.h @@ -41,6 +41,15 @@ extern "C" { #include #include +/** + * @defgroup sparc_leon3 LEON3 Support + * + * @ingroup bsp_sparc + * + * @brief LEON3 support package + * + */ + /* SPARC CPU variant: LEON3 */ #define LEON3 1 diff --git a/c/src/lib/libbsp/sparc/shared/doxygen.h b/c/src/lib/libbsp/sparc/shared/doxygen.h new file mode 100644 index 0000000000..be0b7d672e --- /dev/null +++ b/c/src/lib/libbsp/sparc/shared/doxygen.h @@ -0,0 +1,15 @@ + /** + * @defgroup bsp_sparc SPARC + * + * @ingroup bsp_kit + * + * @brief SPARC Board Support Packages + */ + + /** + * @defgroup sparc_shared SPARC Shared Modules + * + * @ingroup bsp_sparc + * + * @brief SPARC Shared Modules + */ -- cgit v1.2.3