RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

bsps: Adjust architecture Doxygen groups

Browse Source 
- 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.
This commit is contained in:
Sebastian Huber
2019-02-26 15:44:50 +01:00
parent a6e39d4a59
commit 212663bede
58 changed files with 175 additions and 157 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
bsps/arm/beagle/include/bsp.h
View File

@@ -350,7 +350,7 @@ static inline void write_ttbr0(uint32_t bar)
/**
* @defgroup arm_beagle Beaglebone, Beagleboard Support
*
* @ingroup bsp_arm
* @ingroup RTEMSBSPsARM
*
* @brief Beaglebones and beagleboards support package
*

2
bsps/arm/csb336/include/bsp.h
View File

@@ -32,7 +32,7 @@ extern "C" {
/**
* @defgroup arm_csb336 CSB336 Support
*
* @ingroup bsp_arm
* @ingroup RTEMSBSPsARM
*
* @brief CSB336 support package.
*

2
bsps/arm/csb337/include/bsp.h
View File

@@ -31,7 +31,7 @@ extern "C" {
/**
* @defgroup arm_csb337 CSB337 Support
*
* @ingroup bsp_arm
* @ingroup RTEMSBSPsARM
*
* @brief CSB337 support package.
*

2
bsps/arm/csb337/umon/doxygen.h
View File

@@ -1,7 +1,5 @@
/**
* @defgroup shared_umon SHARED UMON Modules
*
* @ingroup bsp_shared
*
* @brief SHARED UMON Modules
*/

2
bsps/arm/edb7312/include/bsp.h
View File

@@ -31,7 +31,7 @@ extern "C" {
/**
* @defgroup arm_edb7312 EDB7312 Support
* @ingroup bsp_arm
* @ingroup RTEMSBSPsARM
* @brief EDB7312 Support Package
* @{
*/

2
bsps/arm/gdbarmsim/include/bsp.h
View File

@@ -32,7 +32,7 @@ extern "C" {
/**
* @defgroup arm_gdbarmsim GDBARMSIM Support
*
* @ingroup bsp_arm
* @ingroup RTEMSBSPsARM
*
* @brief GDBARMSIM support package.
*

2
bsps/arm/gumstix/include/bsp.h
View File

@@ -26,7 +26,7 @@ extern "C" {
/**
* @defgroup arm_gumstix Gumstix Support
* @ingroup bsp_arm
* @ingroup RTEMSBSPsARM
* @brief Gumstix support package
* @{
*/

2
bsps/arm/lm3s69xx/include/bsp.h
View File

@@ -46,7 +46,7 @@
/**
* @defgroup arm_lm3s69xx LM3S69XX Support
*
* @ingroup bsp_arm
* @ingroup RTEMSBSPsARM
*
* @brief LM3S69XX Support Package
*/

2
bsps/arm/lpc176x/include/bsp.h
View File

@@ -47,7 +47,7 @@ struct rtems_bsdnet_ifconfig;
/**
* @defgroup lpc176x LPC176X Support
*
* @ingroup bsp_arm
* @ingroup RTEMSBSPsARM
*
* @brief LPC176X support package.
*

2
bsps/arm/lpc24xx/include/bsp.h
View File

@@ -56,7 +56,7 @@ struct rtems_termios_device_context;
/**
* @defgroup lpc24xx LPC24XX Support
*
* @ingroup bsp_arm
* @ingroup RTEMSBSPsARM
*
* @brief LPC24XX support package.
*

2
bsps/arm/lpc32xx/include/bsp.h
View File

@@ -43,7 +43,7 @@ struct rtems_bsdnet_ifconfig;
/**
* @defgroup arm_lpc32xx LPC32XX Support
*
* @ingroup bsp_arm
* @ingroup RTEMSBSPsARM
*
* @brief LPC32XX support package.
*

2
bsps/arm/raspberrypi/include/bsp.h
View File

@@ -62,7 +62,7 @@ void rpi_start_rtems_on_secondary_processor(void);
/**
* @defgroup arm_raspberrypi Raspberry Pi Support
*
* @ingroup bsp_arm
* @ingroup RTEMSBSPsARM
*
* @brief Raspberry Pi support package
*

2
bsps/arm/realview-pbx-a9/include/bsp.h
View File

@@ -60,7 +60,7 @@ extern "C" {
/**
* @defgroup arm_realview-pbx-a9 Realview PBX-A9
*
* @ingroup bsp_arm
* @ingroup RTEMSBSPsARM
*
* @brief Realview PBX-A9 support package
*

2
bsps/arm/rtl22xx/include/bsp.h
View File

@@ -21,7 +21,7 @@
/**
* @defgroup arm_rtl22xx RTL22XX Support
* @ingroup bsp_arm
* @ingroup RTEMSBSPsARM
* @brief RTL22XX Support Package
* @{
*/

10
bsps/arm/shared/doxygen.h
View File

@@ -1,15 +1,15 @@
/**
* @defgroup bsp_arm ARM
/**
* @defgroup RTEMSBSPsARM ARM
*
* @ingroup bsp_kit
* @ingroup RTEMSBSPs
*
* @brief ARM Board Support Packages
* @brief ARM Board Support Packages.
*/
/**
* @defgroup arm_shared ARM Shared Modules
*
* @ingroup bsp_arm
* @ingroup RTEMSBSPsARM
*
* @brief ARM Shared Modules
*/

2
bsps/arm/stm32f4/include/bsp.h
View File

@@ -20,7 +20,7 @@
/**
* @defgroup arm_stm32f4 STM32F4 Support
* @ingroup bsp_arm
* @ingroup RTEMSBSPsARM
* @brief STM32f4 Support Package
* @{
*/

2
bsps/arm/xilinx-zynq/include/bsp.h
View File

@@ -38,7 +38,7 @@ extern "C" {
/**
* @defgroup arm_zynq Xilinx-Zynq Support
* @ingroup bsp_arm
* @ingroup RTEMSBSPsARM
* @brief Xilinz-Zynq Board Support Package
* @{
*/

2
bsps/bfin/TLL6527M/include/bsp.h
View File

@@ -33,7 +33,7 @@ extern "C" {
/**
* @defgroup bfin_tll6527m TLL6527M Support
* @ingroup bsp_bfin
* @ingroup RTEMSBSPsBfin
* @brief TLL6527M Support Package
* @{
*/

2
bsps/bfin/eZKit533/include/bsp.h
View File

@@ -38,7 +38,7 @@ extern "C" {
/**
* @defgroup bfin_ezkit533 eZKit533 Support
* @ingroup bsp_bfin
* @ingroup RTEMSBSPsBfin
* @brief eZKit533 Board Support Package
* @{
*/

16
bsps/bfin/shared/doxygen.h
View File

@@ -1,11 +1,7 @@
/**
* @defgroup bsp_bfin Blackfin
* @ingroup bsp_kit
* @brief Blackfin Board Support Packages
*/
/**
* @defgroup bfin_shared Blackfin Shared Modules
* @ingroup bsp_bfin
* @brief Blackfin Shared Modules
/**
* @defgroup RTEMSBSPsBfin Blackfin
*
* @ingroup RTEMSBSPs
*
* @brief Blackfin Board Support Packages.
*/

7
bsps/epiphany/shared/doxygen.h Normal file
View File

@@ -0,0 +1,7 @@
/**
* @defgroup RTEMSBSPsEpiphany Epiphany
*
* @ingroup RTEMSBSPs
*
* @brief Epiphany Board Support Packages.
*/

4
bsps/i386/pc386/include/bsp.h
View File

@@ -62,9 +62,9 @@ extern "C" {
#endif
/**
* @degroup pc386_i386 PC386 Support
* @degroup i386_pc386 PC386 Support
*
* @ingroup bsp_i386
* @ingroup RTEMSBSPsI386
*
* @brief PC386 support.
*/

8
bsps/i386/shared/doxygen.h
View File

@@ -1,7 +1,9 @@
/**
* @defgroup bsp_i386 i386
* @ingroup bsp_kit
* @brief i386 Board Support Packages
* @defgroup RTEMSBSPsI386 i386
*
* @ingroup RTEMSBSPs
*
* @brief i386 Board Support Packages.
*/
/**

8
bsps/include/bsp/bootcard.h
View File

@@ -1,9 +1,7 @@
/**
* @file
*
* @ingroup bsp_bootcard
*
* @brief Standard system startup.
* @ingroup RTEMSBSPsSharedStartup
*/
/*
@@ -37,9 +35,9 @@ extern "C" {
#endif /* __cplusplus */
/**
* @defgroup shared_bootcard Bootcard
* @defgroup RTEMSBSPsSharedStartup Bootcard
*
* @ingroup bsp_shared
* @ingroup RTEMSBSPsShared
*
* @brief Standard system startup.
*

2
bsps/include/bsp/irq-generic.h
View File

@@ -110,7 +110,7 @@ static inline rtems_vector_number bsp_interrupt_handler_index(
/**
* @defgroup bsp_interrupt BSP Interrupt Support
*
* @ingroup bsp_shared
* @ingroup RTEMSBSPsShared
*
* @brief Generic BSP Interrupt Support
*

2
bsps/include/bsp/stackalloc.h
View File

@@ -33,7 +33,7 @@ extern "C" {
/**
* @defgroup bsp_stack Task Stack Allocator
*
* @ingroup bsp_shared
* @ingroup RTEMSBSPsShared
*
* @brief Task stack initialization, allocation and free functions.
*

2
bsps/lm32/lm32_evr/include/bsp.h
View File

@@ -30,7 +30,7 @@
/**
* @defgroup lm32_evr EVR Support
*
* @ingroup bsp_lm32
* @ingroup RTEMSBSPsLM32
*
* @brief EVR support package.
*/

2
bsps/lm32/milkymist/include/bsp.h
View File

@@ -29,7 +29,7 @@
/**
* @defgroup lm32_milkymist Milkymist Support
*
* @ingroup bsp_lm32
* @ingroup RTEMSBSPsLM32
*
* @brief Milkymist support package.
*/

10
bsps/lm32/shared/doxygen.h
View File

@@ -1,15 +1,15 @@
/**
* @defgroup bsp_lm32 Lattice Mico32
/**
* @defgroup RTEMSBSPsLM32 LatticeMicro32 (lm32)
*
* @ingroup bsp_kit
* @ingroup RTEMSBSPs
*
* @brief Lattice Mico32 Board Support Packages
* @brief LatticeMicro32 Board Support Packages.
*/
/**
* @defgroup lm32_shared Lattice Mico32 Shared Modules
*
* @ingroup bsp_lm32
* @ingroup RTEMSBSPsLM32
*
* @brief Lattice Mico32 Shared Modules
*/

2
bsps/m68k/av5282/include/bsp.h
View File

@@ -13,7 +13,7 @@
/**
* @defgroup m68k_av5282 AV5282 Support
*
* @ingroup bsp_m68k
* @ingroup RTEMSBSPsM68k
*
* @brief AV5282 support.
*/

2
bsps/m68k/csb360/include/bsp.h
View File

@@ -31,7 +31,7 @@
/**
* @defgroup m68k_csb360 CSB360 Support
*
* @ingroup bsp_m68k
* @ingroup RTEMSBSPsM68k
*
* @brief CSB360 support.
*/

2
bsps/m68k/gen68340/include/bsp.h
View File

@@ -40,7 +40,7 @@ extern "C" {
/**
* @defgroup m68k_gen68340 Motorola MC68340 Support
*
* @ingroup bsp_m68k
* @ingroup RTEMSBSPsM68k
*
* @brief Motorola MC68340 support.
*/

15
bsps/m68k/gen68360/doxygen.h
View File

@@ -1,15 +0,0 @@
/**
* @defgroup bsp_m68k M68K
*
* @ingroup bsp_kit
*
* @brief M68K Board Support Packages
*/
/**
* @defgroup m68k_gen68360 M68K GEN68360 Modules
*
* @ingroup bsp_m68k
*
* @brief M68K GEN68360 Modules
*/

2
bsps/m68k/genmcf548x/include/bsp.h
View File

@@ -60,7 +60,7 @@
/**
* @defgroup m68k_genmcf548x MCF548X Support
*
* @ingroup bsp_m68k
* @ingroup RTEMSBSPsM68k
*
* @brief MCT548X support.
*/

2
bsps/m68k/mcf52235/include/bsp.h
View File

@@ -81,7 +81,7 @@ void Init52235(void);
/**
* @defgroup m68k_mcf52235 MCF52235 Support
*
* @ingroup bsp_m68k
* @ingroup RTEMSBSPsM68k
*
* @brief MCF52235 Support Package
*/

8
bsps/m68k/shared/doxygen.h
View File

@@ -1,15 +1,15 @@
/**
* @defgroup bsp_m68k M68K
* @defgroup RTEMSBSPsM68k Motorola 68000 and NXP ColdFire (m68k)
*
* @ingroup bsp_kit
* @ingroup RTEMSBSPs
*
* @brief M68K Board Support Packages
* @brief Motorola 68000 and NXP ColdFire Board Support Packagess.
*/
/**
* @defgroup m68k_shared M68K Shared Modules
*
* @ingroup bsp_m68k
* @ingroup RTEMSBSPsM68k
*
* @brief M68K Shared Modules
*/

12
bsps/mips/shared/doxygen.h
View File

@@ -1,11 +1,13 @@
/**
* @defgroup bsp_mips MIPS
* @ingroup bsp_kit
* @brief MIPS Board Support Packages
/**
* @defgroup RTEMSBSPsMIPS MIPS
*
* @ingroup RTEMSBSPs
*
* @brief MIPS Board Support Packages.
*/
/**
* @defgroup mips_shared MIPS Shared Modules
* @ingroup bsp_mips
* @ingroup RTEMSBSPsMIPS
* @brief mips Shared Modules
*/

7
bsps/moxie/shared/doxygen.h Normal file
View File

@@ -0,0 +1,7 @@
/**
* @defgroup RTEMSBSPsMoxie Moxie
*
* @ingroup RTEMSBSPs
*
* @brief Moxie Board Support Packages.
*/

7
bsps/nios2/shared/doxygen.h Normal file
View File

@@ -0,0 +1,7 @@
/**
* @defgroup RTEMSBSPsNios2 Nios II (nios2)
*
* @ingroup RTEMSBSPs
*
* @brief Nios II Board Support Packages.
*/

7
bsps/no_cpu/shared/doxygen.h Normal file
View File

@@ -0,0 +1,7 @@
/**
* @defgroup RTEMSBSPsNoCPU Example
*
* @ingroup RTEMSBSPs
*
* @brief Example Board Support Package.
*/

7
bsps/or1k/shared/doxygen.h Normal file
View File

@@ -0,0 +1,7 @@
/**
* @defgroup RTEMSBSPsOR1K OpenRISC 1000 (or1k)
*
* @ingroup RTEMSBSPs
*
* @brief OpenRISC 1000 Board Support Packages.
*/

2
bsps/powerpc/include/bsp/vmeUniverse.h
View File

@@ -57,8 +57,6 @@
/**
* @defgroup shared_vmeuniverse Register definitions
*
* @ingroup bsp_shared
*
* @brief all registers contents in PCI space are LITTLE ENDIAN
*/

15
bsps/powerpc/mvme3100/doxygen.h
View File

@@ -1,15 +0,0 @@
/**
* @defgroup bsp_powerpc POWERPC
*
* @ingroup bsp_kit
*
* @brief POWERPC Board Support Packages
*/
/**
* @defgroup powerpc_mvme3100 POWERPC MVME3100 Modules
*
* @ingroup bsp_powerpc
*
* @brief POWERPC MVME3100 Modules
*/

8
bsps/powerpc/shared/doxygen.h
View File

@@ -1,9 +1,9 @@
/**
* @defgroup bsp_powerpc PowerPC
/**
* @defgroup RTEMSBSPsPowerPc PowerPC
*
* @ingroup bsp_kit
* @ingroup RTEMSBSPs
*
* @brief PowerPC Board Support Packages
* @brief PowerPC Board Support Packages.
*/
/**

2
bsps/powerpc/shared/vme/doxygen.h
View File

@@ -1,7 +1,5 @@
/**
* @defgroup shared_vmeuniverse SHARED VMEUNIVERSE Modules
*
* @ingroup bsp_shared
*
* @brief SHARED VMEUNIVERSE Modules
*/

7
bsps/riscv/shared/doxygen.h Normal file
View File

@@ -0,0 +1,7 @@
/**
* @defgroup RTEMSBSPsRISCV RISC-V
*
* @ingroup RTEMSBSPs
*
* @brief RISC-V Board Support Packages.
*/

7
bsps/sh/shared/doxygen.h Normal file
View File

@@ -0,0 +1,7 @@
/**
* @defgroup RTEMSBSPsSH SuperH (sh)
*
* @ingroup RTEMSBSPs
*
* @brief SuperH Board Support Packages.
*/

2
bsps/shared/dev/clock/clockimpl.h
View File

@@ -32,7 +32,7 @@
/**
* @defgroup bsp_clock Clock Support
*
* @ingroup bsp_shared
* @ingroup RTEMSBSPsShared
*
* @brief Clock support
*

13
bsps/shared/doxygen.h
View File

@@ -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
* @brief Shared Support for Board Support Packages
*/

15
bsps/shared/start/bootcard.c
View File

@@ -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
*/
/*

2
bsps/shared/start/stackalloc.c
View File

@@ -1,7 +1,7 @@
/**
* @file
*
* @ingroup bsp_shared
* @ingroup bsp_stack
*
* @brief Stack initialization, allocation and free functions.
*/

2
bsps/sparc/erc32/include/bsp.h
View File

@@ -39,7 +39,7 @@ extern "C" {
/**
* @defgroup sparc_erc32 ERC32 Support
*
* @ingroup bsp_sparc
* @ingroup RTEMSBSPsSPARC
*
* @brief ERC32 Support Package
*/

2
bsps/sparc/leon2/include/bsp.h
View File

@@ -42,7 +42,7 @@ extern "C" {
/**
* @defgroup sparc_leon2 LEON2 Support
*
* @ingroup bsp_sparc
* @ingroup RTEMSBSPsSPARC
*
* @brief LEON2 Support Package
*

2
bsps/sparc/leon3/include/bsp.h
View File

@@ -42,7 +42,7 @@ extern "C" {
/**
* @defgroup sparc_leon3 LEON3 Support
*
* @ingroup bsp_sparc
* @ingroup RTEMSBSPsSPARC
*
* @brief LEON3 support package
*

10
bsps/sparc/shared/doxygen.h
View File

@@ -1,15 +1,15 @@
/**
* @defgroup bsp_sparc SPARC
/**
* @defgroup RTEMSBSPsSPARC SPARC
*
* @ingroup bsp_kit
* @ingroup RTEMSBSPs
*
* @brief SPARC Board Support Packages
* @brief SPARC Board Support Packages.
*/
/**
* @defgroup sparc_shared SPARC Shared Modules
*
* @ingroup bsp_sparc
* @ingroup RTEMSBSPsSPARC
*
* @brief SPARC Shared Modules
*/

7
bsps/sparc64/shared/doxygen.h Normal file
View File

@@ -0,0 +1,7 @@
/**
* @defgroup RTEMSBSPsSPARC64 SPARC64
*
* @ingroup RTEMSBSPs
*
* @brief SPARC64 Board Support Packages.
*/

7
bsps/v850/shared/doxygen.h Normal file
View File

@@ -0,0 +1,7 @@
/**
* @defgroup RTEMSBSPsV850 V850
*
* @ingroup RTEMSBSPs
*
* @brief V850 Board Support Packages.
*/

7
bsps/x86_64/shared/doxygen.h Normal file
View File

@@ -0,0 +1,7 @@
/**
* @defgroup RTEMSBSPsX8664 x86-64
*
* @ingroup RTEMSBSPs
*
* @brief x86-64 Board Support Packages.
*/