[rtems commit] bsps: Adjust architecture Doxygen groups

Sebastian Huber sebh at rtems.org
Mon Mar 4 06:54:50 UTC 2019


Module:    rtems
Branch:    master
Commit:    212663bede5c183df679560f90f0ad92f995de9b
Changeset: http://git.rtems.org/rtems/commit/?id=212663bede5c183df679560f90f0ad92f995de9b

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Tue Feb 26 15:44:50 2019 +0100

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.

---

 bsps/arm/beagle/include/bsp.h          |  2 +-
 bsps/arm/csb336/include/bsp.h          |  2 +-
 bsps/arm/csb337/include/bsp.h          |  2 +-
 bsps/arm/csb337/umon/doxygen.h         |  4 +---
 bsps/arm/edb7312/include/bsp.h         |  2 +-
 bsps/arm/gdbarmsim/include/bsp.h       |  2 +-
 bsps/arm/gumstix/include/bsp.h         |  2 +-
 bsps/arm/lm3s69xx/include/bsp.h        |  2 +-
 bsps/arm/lpc176x/include/bsp.h         |  2 +-
 bsps/arm/lpc24xx/include/bsp.h         |  2 +-
 bsps/arm/lpc32xx/include/bsp.h         |  2 +-
 bsps/arm/raspberrypi/include/bsp.h     |  2 +-
 bsps/arm/realview-pbx-a9/include/bsp.h |  2 +-
 bsps/arm/rtl22xx/include/bsp.h         |  2 +-
 bsps/arm/shared/doxygen.h              | 16 ++++++++--------
 bsps/arm/stm32f4/include/bsp.h         |  2 +-
 bsps/arm/xilinx-zynq/include/bsp.h     |  2 +-
 bsps/bfin/TLL6527M/include/bsp.h       |  2 +-
 bsps/bfin/eZKit533/include/bsp.h       |  2 +-
 bsps/bfin/shared/doxygen.h             | 18 +++++++-----------
 bsps/epiphany/shared/doxygen.h         |  7 +++++++
 bsps/i386/pc386/include/bsp.h          |  4 ++--
 bsps/i386/shared/doxygen.h             |  8 +++++---
 bsps/include/bsp/bootcard.h            |  8 +++-----
 bsps/include/bsp/irq-generic.h         |  2 +-
 bsps/include/bsp/stackalloc.h          |  2 +-
 bsps/lm32/lm32_evr/include/bsp.h       |  2 +-
 bsps/lm32/milkymist/include/bsp.h      |  2 +-
 bsps/lm32/shared/doxygen.h             | 16 ++++++++--------
 bsps/m68k/av5282/include/bsp.h         |  2 +-
 bsps/m68k/csb360/include/bsp.h         |  2 +-
 bsps/m68k/gen68340/include/bsp.h       |  2 +-
 bsps/m68k/gen68360/doxygen.h           | 15 ---------------
 bsps/m68k/genmcf548x/include/bsp.h     |  2 +-
 bsps/m68k/mcf52235/include/bsp.h       |  2 +-
 bsps/m68k/shared/doxygen.h             | 16 ++++++++--------
 bsps/mips/shared/doxygen.h             | 14 ++++++++------
 bsps/moxie/shared/doxygen.h            |  7 +++++++
 bsps/nios2/shared/doxygen.h            |  7 +++++++
 bsps/no_cpu/shared/doxygen.h           |  7 +++++++
 bsps/or1k/shared/doxygen.h             |  7 +++++++
 bsps/powerpc/include/bsp/vmeUniverse.h |  2 --
 bsps/powerpc/mvme3100/doxygen.h        | 15 ---------------
 bsps/powerpc/shared/doxygen.h          | 14 +++++++-------
 bsps/powerpc/shared/vme/doxygen.h      |  4 +---
 bsps/riscv/shared/doxygen.h            |  7 +++++++
 bsps/sh/shared/doxygen.h               |  7 +++++++
 bsps/shared/dev/clock/clockimpl.h      |  2 +-
 bsps/shared/doxygen.h                  | 15 +++++++--------
 bsps/shared/start/bootcard.c           | 15 +--------------
 bsps/shared/start/stackalloc.c         |  2 +-
 bsps/sparc/erc32/include/bsp.h         |  2 +-
 bsps/sparc/leon2/include/bsp.h         |  2 +-
 bsps/sparc/leon3/include/bsp.h         |  2 +-
 bsps/sparc/shared/doxygen.h            | 16 ++++++++--------
 bsps/sparc64/shared/doxygen.h          |  7 +++++++
 bsps/v850/shared/doxygen.h             |  7 +++++++
 bsps/x86_64/shared/doxygen.h           |  7 +++++++
 58 files changed, 175 insertions(+), 157 deletions(-)

diff --git a/bsps/arm/beagle/include/bsp.h b/bsps/arm/beagle/include/bsp.h
index 7767456..f15d910 100644
--- a/bsps/arm/beagle/include/bsp.h
+++ b/bsps/arm/beagle/include/bsp.h
@@ -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
  *
diff --git a/bsps/arm/csb336/include/bsp.h b/bsps/arm/csb336/include/bsp.h
index ed036d5..c886dd9 100644
--- a/bsps/arm/csb336/include/bsp.h
+++ b/bsps/arm/csb336/include/bsp.h
@@ -32,7 +32,7 @@ extern "C" {
 /**
  * @defgroup arm_csb336 CSB336 Support
  *
- * @ingroup bsp_arm
+ * @ingroup RTEMSBSPsARM
  *
  * @brief CSB336 support package.
  *
diff --git a/bsps/arm/csb337/include/bsp.h b/bsps/arm/csb337/include/bsp.h
index c99de2f..c757bf1 100644
--- a/bsps/arm/csb337/include/bsp.h
+++ b/bsps/arm/csb337/include/bsp.h
@@ -31,7 +31,7 @@ extern "C" {
 /**
  * @defgroup arm_csb337 CSB337 Support
  *
- * @ingroup bsp_arm
+ * @ingroup RTEMSBSPsARM
  *
  * @brief CSB337 support package.
  *
diff --git a/bsps/arm/csb337/umon/doxygen.h b/bsps/arm/csb337/umon/doxygen.h
index a74d3c3..dbf48d6 100644
--- a/bsps/arm/csb337/umon/doxygen.h
+++ b/bsps/arm/csb337/umon/doxygen.h
@@ -1,7 +1,5 @@
 /**
  *  @defgroup shared_umon SHARED UMON Modules
  *
- *  @ingroup bsp_shared
- *
  *  @brief SHARED UMON Modules
- */
\ No newline at end of file
+ */
diff --git a/bsps/arm/edb7312/include/bsp.h b/bsps/arm/edb7312/include/bsp.h
index fa7a480..0317ed7 100644
--- a/bsps/arm/edb7312/include/bsp.h
+++ b/bsps/arm/edb7312/include/bsp.h
@@ -31,7 +31,7 @@ extern "C" {
 
 /**
  * @defgroup arm_edb7312 EDB7312 Support
- * @ingroup bsp_arm
+ * @ingroup RTEMSBSPsARM
  * @brief EDB7312 Support Package
  * @{
  */
diff --git a/bsps/arm/gdbarmsim/include/bsp.h b/bsps/arm/gdbarmsim/include/bsp.h
index 0010d58..66e5636 100644
--- a/bsps/arm/gdbarmsim/include/bsp.h
+++ b/bsps/arm/gdbarmsim/include/bsp.h
@@ -32,7 +32,7 @@ extern "C" {
 /**
  * @defgroup arm_gdbarmsim GDBARMSIM Support
  *
- * @ingroup bsp_arm
+ * @ingroup RTEMSBSPsARM
  *
  * @brief GDBARMSIM support package.
  *
diff --git a/bsps/arm/gumstix/include/bsp.h b/bsps/arm/gumstix/include/bsp.h
index 33cc6e4..687ffde 100644
--- a/bsps/arm/gumstix/include/bsp.h
+++ b/bsps/arm/gumstix/include/bsp.h
@@ -26,7 +26,7 @@ extern "C" {
 
 /**
  * @defgroup arm_gumstix Gumstix Support
- * @ingroup bsp_arm
+ * @ingroup RTEMSBSPsARM
  * @brief Gumstix support package
  * @{
  */
diff --git a/bsps/arm/lm3s69xx/include/bsp.h b/bsps/arm/lm3s69xx/include/bsp.h
index b07656c..1fae730 100644
--- a/bsps/arm/lm3s69xx/include/bsp.h
+++ b/bsps/arm/lm3s69xx/include/bsp.h
@@ -46,7 +46,7 @@
 /**
  * @defgroup arm_lm3s69xx LM3S69XX Support
  *
- * @ingroup bsp_arm
+ * @ingroup RTEMSBSPsARM
  *
  * @brief LM3S69XX Support Package
  */
diff --git a/bsps/arm/lpc176x/include/bsp.h b/bsps/arm/lpc176x/include/bsp.h
index 14c55f4..8c34de5 100644
--- a/bsps/arm/lpc176x/include/bsp.h
+++ b/bsps/arm/lpc176x/include/bsp.h
@@ -47,7 +47,7 @@ struct rtems_bsdnet_ifconfig;
 /**
  * @defgroup lpc176x LPC176X Support
  *
- * @ingroup bsp_arm
+ * @ingroup RTEMSBSPsARM
  *
  * @brief LPC176X support package.
  *
diff --git a/bsps/arm/lpc24xx/include/bsp.h b/bsps/arm/lpc24xx/include/bsp.h
index 5424808..ac59a2a 100644
--- a/bsps/arm/lpc24xx/include/bsp.h
+++ b/bsps/arm/lpc24xx/include/bsp.h
@@ -56,7 +56,7 @@ struct rtems_termios_device_context;
 /**
  * @defgroup lpc24xx LPC24XX Support
  *
- * @ingroup bsp_arm
+ * @ingroup RTEMSBSPsARM
  *
  * @brief LPC24XX support package.
  *
diff --git a/bsps/arm/lpc32xx/include/bsp.h b/bsps/arm/lpc32xx/include/bsp.h
index 8ccb637..a91f92b 100644
--- a/bsps/arm/lpc32xx/include/bsp.h
+++ b/bsps/arm/lpc32xx/include/bsp.h
@@ -43,7 +43,7 @@ struct rtems_bsdnet_ifconfig;
 /**
  * @defgroup arm_lpc32xx LPC32XX Support
  *
- * @ingroup bsp_arm
+ * @ingroup RTEMSBSPsARM
  *
  * @brief LPC32XX support package.
  *
diff --git a/bsps/arm/raspberrypi/include/bsp.h b/bsps/arm/raspberrypi/include/bsp.h
index ecd5b6a..4e8c6c9 100644
--- a/bsps/arm/raspberrypi/include/bsp.h
+++ b/bsps/arm/raspberrypi/include/bsp.h
@@ -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
  *
diff --git a/bsps/arm/realview-pbx-a9/include/bsp.h b/bsps/arm/realview-pbx-a9/include/bsp.h
index 4423984..7e0bac3 100644
--- a/bsps/arm/realview-pbx-a9/include/bsp.h
+++ b/bsps/arm/realview-pbx-a9/include/bsp.h
@@ -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
  *
diff --git a/bsps/arm/rtl22xx/include/bsp.h b/bsps/arm/rtl22xx/include/bsp.h
index 9b376da..6486159 100644
--- a/bsps/arm/rtl22xx/include/bsp.h
+++ b/bsps/arm/rtl22xx/include/bsp.h
@@ -21,7 +21,7 @@
 
 /**
  * @defgroup arm_rtl22xx RTL22XX Support
- * @ingroup bsp_arm
+ * @ingroup RTEMSBSPsARM
  * @brief RTL22XX Support Package
  * @{
  */
diff --git a/bsps/arm/shared/doxygen.h b/bsps/arm/shared/doxygen.h
index 8303510..5c685c7 100644
--- a/bsps/arm/shared/doxygen.h
+++ b/bsps/arm/shared/doxygen.h
@@ -1,15 +1,15 @@
-  /**
-  *  @defgroup bsp_arm ARM
-  *
-  *  @ingroup bsp_kit
-  *
-  *  @brief ARM Board Support Packages
-  */
+/**
+ * @defgroup RTEMSBSPsARM ARM
+ *
+ * @ingroup RTEMSBSPs
+ *
+ * @brief ARM Board Support Packages.
+ */
 
  /**
   *  @defgroup arm_shared ARM Shared Modules
   *
-  *  @ingroup bsp_arm
+  *  @ingroup RTEMSBSPsARM
   *
   *  @brief ARM Shared Modules
   */
diff --git a/bsps/arm/stm32f4/include/bsp.h b/bsps/arm/stm32f4/include/bsp.h
index 50052bc..30ab881 100644
--- a/bsps/arm/stm32f4/include/bsp.h
+++ b/bsps/arm/stm32f4/include/bsp.h
@@ -20,7 +20,7 @@
 
 /**
  * @defgroup arm_stm32f4 STM32F4 Support
- * @ingroup bsp_arm
+ * @ingroup RTEMSBSPsARM
  * @brief STM32f4 Support Package
  * @{
  */
diff --git a/bsps/arm/xilinx-zynq/include/bsp.h b/bsps/arm/xilinx-zynq/include/bsp.h
index afc6a66..72b9819 100644
--- a/bsps/arm/xilinx-zynq/include/bsp.h
+++ b/bsps/arm/xilinx-zynq/include/bsp.h
@@ -38,7 +38,7 @@ extern "C" {
 
 /**
  * @defgroup arm_zynq Xilinx-Zynq Support
- * @ingroup bsp_arm
+ * @ingroup RTEMSBSPsARM
  * @brief Xilinz-Zynq Board Support Package
  * @{
  */
diff --git a/bsps/bfin/TLL6527M/include/bsp.h b/bsps/bfin/TLL6527M/include/bsp.h
index 0e20191..96321f8 100644
--- a/bsps/bfin/TLL6527M/include/bsp.h
+++ b/bsps/bfin/TLL6527M/include/bsp.h
@@ -33,7 +33,7 @@ extern "C" {
 
 /**
  * @defgroup bfin_tll6527m TLL6527M Support
- * @ingroup bsp_bfin
+ * @ingroup RTEMSBSPsBfin
  * @brief TLL6527M Support Package
  * @{
  */
diff --git a/bsps/bfin/eZKit533/include/bsp.h b/bsps/bfin/eZKit533/include/bsp.h
index 865ed72..476769e 100644
--- a/bsps/bfin/eZKit533/include/bsp.h
+++ b/bsps/bfin/eZKit533/include/bsp.h
@@ -38,7 +38,7 @@ extern "C" {
 
 /**
  * @defgroup bfin_ezkit533 eZKit533 Support
- * @ingroup bsp_bfin
+ * @ingroup RTEMSBSPsBfin
  * @brief eZKit533 Board Support Package
  * @{
  */
diff --git a/bsps/bfin/shared/doxygen.h b/bsps/bfin/shared/doxygen.h
index 752b513..0a33c97a 100644
--- a/bsps/bfin/shared/doxygen.h
+++ b/bsps/bfin/shared/doxygen.h
@@ -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.
+ */
diff --git a/bsps/epiphany/shared/doxygen.h b/bsps/epiphany/shared/doxygen.h
new file mode 100644
index 0000000..2b7e54e
--- /dev/null
+++ b/bsps/epiphany/shared/doxygen.h
@@ -0,0 +1,7 @@
+/**
+ * @defgroup RTEMSBSPsEpiphany Epiphany
+ *
+ * @ingroup RTEMSBSPs
+ *
+ * @brief Epiphany Board Support Packages.
+ */
diff --git a/bsps/i386/pc386/include/bsp.h b/bsps/i386/pc386/include/bsp.h
index 4ff8952..3049ee5 100644
--- a/bsps/i386/pc386/include/bsp.h
+++ b/bsps/i386/pc386/include/bsp.h
@@ -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.
  */
diff --git a/bsps/i386/shared/doxygen.h b/bsps/i386/shared/doxygen.h
index b1dd495..8b1e7c0 100644
--- a/bsps/i386/shared/doxygen.h
+++ b/bsps/i386/shared/doxygen.h
@@ -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.
  */
 
 /**
diff --git a/bsps/include/bsp/bootcard.h b/bsps/include/bsp/bootcard.h
index f780005..02feaa4 100644
--- a/bsps/include/bsp/bootcard.h
+++ b/bsps/include/bsp/bootcard.h
@@ -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.
  *
diff --git a/bsps/include/bsp/irq-generic.h b/bsps/include/bsp/irq-generic.h
index 187aea8..31835d0 100644
--- a/bsps/include/bsp/irq-generic.h
+++ b/bsps/include/bsp/irq-generic.h
@@ -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
  *
diff --git a/bsps/include/bsp/stackalloc.h b/bsps/include/bsp/stackalloc.h
index 89414c8..7169759 100644
--- a/bsps/include/bsp/stackalloc.h
+++ b/bsps/include/bsp/stackalloc.h
@@ -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.
  *
diff --git a/bsps/lm32/lm32_evr/include/bsp.h b/bsps/lm32/lm32_evr/include/bsp.h
index 4f6c9ee..7ffc525 100644
--- a/bsps/lm32/lm32_evr/include/bsp.h
+++ b/bsps/lm32/lm32_evr/include/bsp.h
@@ -30,7 +30,7 @@
 /**
  * @defgroup lm32_evr EVR Support
  *
- * @ingroup bsp_lm32
+ * @ingroup RTEMSBSPsLM32
  *
  * @brief EVR support package.
  */
diff --git a/bsps/lm32/milkymist/include/bsp.h b/bsps/lm32/milkymist/include/bsp.h
index d8af4a3..254da0d 100644
--- a/bsps/lm32/milkymist/include/bsp.h
+++ b/bsps/lm32/milkymist/include/bsp.h
@@ -29,7 +29,7 @@
 /**
  * @defgroup lm32_milkymist Milkymist Support
  * 
- * @ingroup bsp_lm32
+ * @ingroup RTEMSBSPsLM32
  * 
  * @brief Milkymist support package.
  */
diff --git a/bsps/lm32/shared/doxygen.h b/bsps/lm32/shared/doxygen.h
index 134bd1f..ace1205 100644
--- a/bsps/lm32/shared/doxygen.h
+++ b/bsps/lm32/shared/doxygen.h
@@ -1,15 +1,15 @@
-  /**
-  *  @defgroup bsp_lm32 Lattice Mico32
-  *
-  *  @ingroup bsp_kit
-  *
-  *  @brief Lattice Mico32 Board Support Packages
-  */
+/**
+ * @defgroup RTEMSBSPsLM32 LatticeMicro32 (lm32)
+ *
+ * @ingroup RTEMSBSPs
+ *
+ * @brief LatticeMicro32 Board Support Packages.
+ */
 
  /**
   *  @defgroup lm32_shared Lattice Mico32 Shared Modules
   *
-  *  @ingroup bsp_lm32
+  *  @ingroup RTEMSBSPsLM32
   *
   *  @brief Lattice Mico32 Shared Modules
   */
diff --git a/bsps/m68k/av5282/include/bsp.h b/bsps/m68k/av5282/include/bsp.h
index a8b32e7..643a0c9 100644
--- a/bsps/m68k/av5282/include/bsp.h
+++ b/bsps/m68k/av5282/include/bsp.h
@@ -13,7 +13,7 @@
 /**
  * @defgroup m68k_av5282 AV5282 Support
  *
- * @ingroup bsp_m68k
+ * @ingroup RTEMSBSPsM68k
  *
  * @brief AV5282 support.
  */
diff --git a/bsps/m68k/csb360/include/bsp.h b/bsps/m68k/csb360/include/bsp.h
index 5272e17..eceb790 100644
--- a/bsps/m68k/csb360/include/bsp.h
+++ b/bsps/m68k/csb360/include/bsp.h
@@ -31,7 +31,7 @@
 /**
  * @defgroup m68k_csb360 CSB360 Support
  *
- * @ingroup bsp_m68k
+ * @ingroup RTEMSBSPsM68k
  *
  * @brief CSB360 support.
  */
diff --git a/bsps/m68k/gen68340/include/bsp.h b/bsps/m68k/gen68340/include/bsp.h
index 28d86ff..ca9c79e 100644
--- a/bsps/m68k/gen68340/include/bsp.h
+++ b/bsps/m68k/gen68340/include/bsp.h
@@ -40,7 +40,7 @@ extern "C" {
 /**
  * @defgroup m68k_gen68340 Motorola MC68340 Support
  *
- * @ingroup bsp_m68k
+ * @ingroup RTEMSBSPsM68k
  *
  * @brief Motorola MC68340 support.
  */
diff --git a/bsps/m68k/gen68360/doxygen.h b/bsps/m68k/gen68360/doxygen.h
deleted file mode 100644
index 2a692d2..0000000
--- a/bsps/m68k/gen68360/doxygen.h
+++ /dev/null
@@ -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
- */
\ No newline at end of file
diff --git a/bsps/m68k/genmcf548x/include/bsp.h b/bsps/m68k/genmcf548x/include/bsp.h
index 77a7bca..82d9287 100644
--- a/bsps/m68k/genmcf548x/include/bsp.h
+++ b/bsps/m68k/genmcf548x/include/bsp.h
@@ -60,7 +60,7 @@
 /**
  * @defgroup m68k_genmcf548x MCF548X Support
  *
- * @ingroup bsp_m68k
+ * @ingroup RTEMSBSPsM68k
  *
  * @brief MCT548X support.
  */
diff --git a/bsps/m68k/mcf52235/include/bsp.h b/bsps/m68k/mcf52235/include/bsp.h
index ef3b928..df30017 100644
--- a/bsps/m68k/mcf52235/include/bsp.h
+++ b/bsps/m68k/mcf52235/include/bsp.h
@@ -81,7 +81,7 @@ void Init52235(void);
 /**
  * @defgroup m68k_mcf52235 MCF52235 Support
  *
- * @ingroup bsp_m68k
+ * @ingroup RTEMSBSPsM68k
  *
  * @brief MCF52235 Support Package
  */
diff --git a/bsps/m68k/shared/doxygen.h b/bsps/m68k/shared/doxygen.h
index 0877c51..6cf60f2 100644
--- a/bsps/m68k/shared/doxygen.h
+++ b/bsps/m68k/shared/doxygen.h
@@ -1,15 +1,15 @@
 /**
-  *  @defgroup bsp_m68k M68K
-  *
-  *  @ingroup bsp_kit
-  *
-  *  @brief M68K Board Support Packages
-  */
+ * @defgroup RTEMSBSPsM68k Motorola 68000 and NXP ColdFire (m68k)
+ *
+ * @ingroup RTEMSBSPs
+ *
+ * @brief Motorola 68000 and NXP ColdFire Board Support Packagess.
+ */
 
 /**
   *  @defgroup m68k_shared M68K Shared Modules
   *
-  *  @ingroup bsp_m68k
+  *  @ingroup RTEMSBSPsM68k
   *
   *  @brief M68K Shared Modules
-  */
\ No newline at end of file
+  */
diff --git a/bsps/mips/shared/doxygen.h b/bsps/mips/shared/doxygen.h
index 755675f..439f0b8 100644
--- a/bsps/mips/shared/doxygen.h
+++ b/bsps/mips/shared/doxygen.h
@@ -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
   */
diff --git a/bsps/moxie/shared/doxygen.h b/bsps/moxie/shared/doxygen.h
new file mode 100644
index 0000000..e60a556
--- /dev/null
+++ b/bsps/moxie/shared/doxygen.h
@@ -0,0 +1,7 @@
+/**
+ * @defgroup RTEMSBSPsMoxie Moxie
+ *
+ * @ingroup RTEMSBSPs
+ *
+ * @brief Moxie Board Support Packages.
+ */
diff --git a/bsps/nios2/shared/doxygen.h b/bsps/nios2/shared/doxygen.h
new file mode 100644
index 0000000..5dd48fb
--- /dev/null
+++ b/bsps/nios2/shared/doxygen.h
@@ -0,0 +1,7 @@
+/**
+ * @defgroup RTEMSBSPsNios2 Nios II (nios2)
+ *
+ * @ingroup RTEMSBSPs
+ *
+ * @brief Nios II Board Support Packages.
+ */
diff --git a/bsps/no_cpu/shared/doxygen.h b/bsps/no_cpu/shared/doxygen.h
new file mode 100644
index 0000000..4d2f5f9
--- /dev/null
+++ b/bsps/no_cpu/shared/doxygen.h
@@ -0,0 +1,7 @@
+/**
+ * @defgroup RTEMSBSPsNoCPU Example
+ *
+ * @ingroup RTEMSBSPs
+ *
+ * @brief Example Board Support Package.
+ */
diff --git a/bsps/or1k/shared/doxygen.h b/bsps/or1k/shared/doxygen.h
new file mode 100644
index 0000000..5025c13
--- /dev/null
+++ b/bsps/or1k/shared/doxygen.h
@@ -0,0 +1,7 @@
+/**
+ * @defgroup RTEMSBSPsOR1K OpenRISC 1000 (or1k)
+ *
+ * @ingroup RTEMSBSPs
+ *
+ * @brief OpenRISC 1000 Board Support Packages.
+ */
diff --git a/bsps/powerpc/include/bsp/vmeUniverse.h b/bsps/powerpc/include/bsp/vmeUniverse.h
index 7cb9f8d..7f68096 100644
--- a/bsps/powerpc/include/bsp/vmeUniverse.h
+++ b/bsps/powerpc/include/bsp/vmeUniverse.h
@@ -57,8 +57,6 @@
 /**
  *  @defgroup shared_vmeuniverse Register definitions
  *
- *  @ingroup bsp_shared
- *
  *  @brief all registers contents in PCI space are LITTLE ENDIAN
  */
 
diff --git a/bsps/powerpc/mvme3100/doxygen.h b/bsps/powerpc/mvme3100/doxygen.h
deleted file mode 100644
index 59ae7ef..0000000
--- a/bsps/powerpc/mvme3100/doxygen.h
+++ /dev/null
@@ -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
- */
\ No newline at end of file
diff --git a/bsps/powerpc/shared/doxygen.h b/bsps/powerpc/shared/doxygen.h
index 30c616e..6638615 100644
--- a/bsps/powerpc/shared/doxygen.h
+++ b/bsps/powerpc/shared/doxygen.h
@@ -1,10 +1,10 @@
-  /**
-  *  @defgroup bsp_powerpc PowerPC
-  *
-  *  @ingroup bsp_kit
-  *
-  *  @brief PowerPC Board Support Packages
-  */
+/**
+ * @defgroup RTEMSBSPsPowerPc PowerPC
+ *
+ * @ingroup RTEMSBSPs
+ *
+ * @brief PowerPC Board Support Packages.
+ */
 
  /**
   *  @defgroup powerpc_shared PowerPC Shared Modules
diff --git a/bsps/powerpc/shared/vme/doxygen.h b/bsps/powerpc/shared/vme/doxygen.h
index 88ded94..2ccdeda 100644
--- a/bsps/powerpc/shared/vme/doxygen.h
+++ b/bsps/powerpc/shared/vme/doxygen.h
@@ -1,7 +1,5 @@
 /**
  *  @defgroup shared_vmeuniverse SHARED VMEUNIVERSE Modules
  *
- *  @ingroup bsp_shared
- *
  *  @brief SHARED VMEUNIVERSE Modules
- */
\ No newline at end of file
+ */
diff --git a/bsps/riscv/shared/doxygen.h b/bsps/riscv/shared/doxygen.h
new file mode 100644
index 0000000..c7712ee
--- /dev/null
+++ b/bsps/riscv/shared/doxygen.h
@@ -0,0 +1,7 @@
+/**
+ * @defgroup RTEMSBSPsRISCV RISC-V
+ *
+ * @ingroup RTEMSBSPs
+ *
+ * @brief RISC-V Board Support Packages.
+ */
diff --git a/bsps/sh/shared/doxygen.h b/bsps/sh/shared/doxygen.h
new file mode 100644
index 0000000..ae5d985
--- /dev/null
+++ b/bsps/sh/shared/doxygen.h
@@ -0,0 +1,7 @@
+/**
+ * @defgroup RTEMSBSPsSH SuperH (sh)
+ *
+ * @ingroup RTEMSBSPs
+ *
+ * @brief SuperH Board Support Packages.
+ */
diff --git a/bsps/shared/dev/clock/clockimpl.h b/bsps/shared/dev/clock/clockimpl.h
index f3a41b1..7913cde 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 bbc7bb9..538ed9e 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 83030f2..542785b 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 at 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 3e3b83e..f7cf7be 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.
  */
diff --git a/bsps/sparc/erc32/include/bsp.h b/bsps/sparc/erc32/include/bsp.h
index 71719f9..2941db0 100644
--- a/bsps/sparc/erc32/include/bsp.h
+++ b/bsps/sparc/erc32/include/bsp.h
@@ -39,7 +39,7 @@ extern "C" {
 /**
  * @defgroup sparc_erc32 ERC32 Support
  *
- * @ingroup bsp_sparc
+ * @ingroup RTEMSBSPsSPARC
  *
  * @brief ERC32 Support Package
  */
diff --git a/bsps/sparc/leon2/include/bsp.h b/bsps/sparc/leon2/include/bsp.h
index e9b9849..82f7728 100644
--- a/bsps/sparc/leon2/include/bsp.h
+++ b/bsps/sparc/leon2/include/bsp.h
@@ -42,7 +42,7 @@ extern "C" {
 /**
  *  @defgroup sparc_leon2 LEON2 Support
  *
- *  @ingroup bsp_sparc
+ *  @ingroup RTEMSBSPsSPARC
  *
  *  @brief LEON2 Support Package
  *
diff --git a/bsps/sparc/leon3/include/bsp.h b/bsps/sparc/leon3/include/bsp.h
index 3fda4ed..c35e537 100644
--- a/bsps/sparc/leon3/include/bsp.h
+++ b/bsps/sparc/leon3/include/bsp.h
@@ -42,7 +42,7 @@ extern "C" {
 /**
  *  @defgroup sparc_leon3 LEON3 Support
  *
- *  @ingroup bsp_sparc
+ *  @ingroup RTEMSBSPsSPARC
  *
  *  @brief LEON3 support package
  *
diff --git a/bsps/sparc/shared/doxygen.h b/bsps/sparc/shared/doxygen.h
index be0b7d6..a5907d2 100644
--- a/bsps/sparc/shared/doxygen.h
+++ b/bsps/sparc/shared/doxygen.h
@@ -1,15 +1,15 @@
- /**
-  *  @defgroup bsp_sparc SPARC
-  *
-  *  @ingroup bsp_kit
-  *
-  *  @brief SPARC Board Support Packages
-  */
+/**
+ * @defgroup RTEMSBSPsSPARC SPARC
+ *
+ * @ingroup RTEMSBSPs
+ *
+ * @brief SPARC Board Support Packages.
+ */
 
  /**
   *  @defgroup sparc_shared SPARC Shared Modules
   *
-  *  @ingroup bsp_sparc
+  *  @ingroup RTEMSBSPsSPARC
   *
   *  @brief SPARC Shared Modules
   */
diff --git a/bsps/sparc64/shared/doxygen.h b/bsps/sparc64/shared/doxygen.h
new file mode 100644
index 0000000..0bfcceb
--- /dev/null
+++ b/bsps/sparc64/shared/doxygen.h
@@ -0,0 +1,7 @@
+/**
+ * @defgroup RTEMSBSPsSPARC64 SPARC64
+ *
+ * @ingroup RTEMSBSPs
+ *
+ * @brief SPARC64 Board Support Packages.
+ */
diff --git a/bsps/v850/shared/doxygen.h b/bsps/v850/shared/doxygen.h
new file mode 100644
index 0000000..beaaa35
--- /dev/null
+++ b/bsps/v850/shared/doxygen.h
@@ -0,0 +1,7 @@
+/**
+ * @defgroup RTEMSBSPsV850 V850
+ *
+ * @ingroup RTEMSBSPs
+ *
+ * @brief V850 Board Support Packages.
+ */
diff --git a/bsps/x86_64/shared/doxygen.h b/bsps/x86_64/shared/doxygen.h
new file mode 100644
index 0000000..6d0e464
--- /dev/null
+++ b/bsps/x86_64/shared/doxygen.h
@@ -0,0 +1,7 @@
+/**
+ * @defgroup RTEMSBSPsX8664 x86-64
+ *
+ * @ingroup RTEMSBSPs
+ *
+ * @brief x86-64 Board Support Packages.
+ */




More information about the vc mailing list