[PATCH 2/5] bsps: Adjust shared Doxygen groups
Sebastian Huber
sebastian.huber at embedded-brains.de
Thu Mar 7 12:51:50 UTC 2019
Update #3706.
---
bsps/arm/include/bsp/arm-a8core-start.h | 2 +-
bsps/arm/include/bsp/arm-a9mpcore-irq.h | 2 +-
bsps/arm/include/bsp/arm-a9mpcore-regs.h | 2 +-
bsps/arm/include/bsp/arm-a9mpcore-start.h | 2 +-
bsps/arm/include/bsp/arm-errata.h | 2 +-
bsps/arm/include/bsp/arm-gic.h | 2 +-
bsps/arm/include/bsp/arm-pl011-regs.h | 2 +-
bsps/arm/include/bsp/arm-pl011.h | 2 +-
bsps/arm/include/bsp/arm-pl050-regs.h | 2 +-
bsps/arm/include/bsp/arm-pl050.h | 2 +-
bsps/arm/include/bsp/arm-pl111-fb.h | 2 +-
bsps/arm/include/bsp/arm-pl111-regs.h | 2 +-
bsps/arm/include/bsp/arm-release-id.h | 2 +-
bsps/arm/include/bsp/armv7m-irq.h | 2 +-
bsps/arm/include/bsp/linker-symbols.h | 2 +-
bsps/arm/include/bsp/start.h | 2 +-
bsps/arm/shared/cache/cache-cp15.h | 2 +-
bsps/arm/shared/cache/cache-l2c-310.c | 2 +-
bsps/arm/shared/doxygen.h | 14 ++++++-------
bsps/epiphany/include/bsp/linker-symbols.h | 2 +-
bsps/epiphany/shared/doxygen.h | 8 ++++++++
bsps/i386/include/bsp/irq.h | 2 +-
bsps/i386/include/bsp/realmode_int.h | 2 +-
bsps/i386/include/bsp/smp-imps.h | 2 +-
bsps/i386/pc386/start/realmode_int.c | 2 +-
bsps/i386/shared/doxygen.h | 10 ++-------
bsps/include/bsp/console-termios.h | 2 +-
bsps/include/bsp/default-initial-extension.h | 2 +-
bsps/include/bsp/u-boot.h | 2 +-
bsps/include/grlib/ambapp.h | 15 +++++++++++---
bsps/include/grlib/apbuart.h | 15 +++++++++++---
bsps/include/grlib/b1553brm.h | 15 +++++++++++---
bsps/include/grlib/debug_defs.h | 5 +----
bsps/include/grlib/grcan.h | 15 +++++++++++---
bsps/include/grlib/grlib.h | 8 ++++++++
bsps/include/grlib/grspw.h | 15 +++++++++++---
bsps/include/grlib/i2cmst.h | 15 +++++++++++---
bsps/lm32/include/bsp/milkymist_ac97.h | 4 ++--
bsps/lm32/include/bsp/milkymist_buttons.h | 4 ++--
bsps/lm32/include/bsp/milkymist_dmx.h | 4 ++--
bsps/lm32/include/bsp/milkymist_flash.h | 4 ++--
bsps/lm32/include/bsp/milkymist_gpio.h | 4 ++--
bsps/lm32/include/bsp/milkymist_ir.h | 4 ++--
bsps/lm32/include/bsp/milkymist_memcard.h | 4 ++--
bsps/lm32/include/bsp/milkymist_midi.h | 4 ++--
bsps/lm32/include/bsp/milkymist_pfpu.h | 4 ++--
bsps/lm32/include/bsp/milkymist_tmu.h | 4 ++--
bsps/lm32/include/bsp/milkymist_usbinput.h | 4 ++--
bsps/lm32/include/bsp/milkymist_versions.h | 4 ++--
bsps/lm32/include/bsp/milkymist_video.h | 4 ++--
bsps/lm32/shared/clock/clock.h | 2 +-
bsps/lm32/shared/console/uart.h | 4 ++--
bsps/lm32/shared/doxygen.h | 28 +++++++++++++-------------
bsps/lm32/shared/gdbstub/gdb_if.h | 2 +-
bsps/lm32/shared/milkymist_clock/clock.h | 2 +-
bsps/lm32/shared/milkymist_console/uart.h | 2 +-
bsps/lm32/shared/milkymist_usbinput/comloc.h | 2 +-
bsps/lm32/shared/net/network.h | 4 ++--
bsps/lm32/shared/net/tsmac.h | 2 +-
bsps/m68k/include/bsp/linker-symbols.h | 4 ++--
bsps/m68k/include/mvme16x_hw.h | 2 +-
bsps/m68k/shared/doxygen.h | 14 ++++++-------
bsps/m68k/shared/gdbstub/gdb_if.h | 2 +-
bsps/mips/include/bsp/i8259.h | 2 +-
bsps/mips/include/bsp/regs.h | 2 +-
bsps/mips/shared/doxygen.h | 12 ++++++-----
bsps/mips/shared/gdbstub/gdb_if.h | 2 +-
bsps/mips/shared/gdbstub/memlimits.h | 2 +-
bsps/mips/shared/gdbstub/mips_opcode.h | 2 +-
bsps/or1k/include/bsp/linker-symbols.h | 4 ++--
bsps/powerpc/include/bsp/linker-symbols.h | 4 ++--
bsps/powerpc/include/bsp/start.h | 4 ++--
bsps/powerpc/include/bsp/tictac.h | 2 +-
bsps/powerpc/include/bsp/vectors.h | 8 ++++----
bsps/powerpc/include/bsp/vmeUniverse.h | 4 +++-
bsps/powerpc/include/libcpu/powerpc-utility.h | 12 +++++++++--
bsps/powerpc/shared/cache/cache.c | 2 +-
bsps/powerpc/shared/clock/clock.c | 2 +-
bsps/powerpc/shared/doxygen.h | 14 ++++++-------
bsps/powerpc/shared/exceptions/ppc-code-copy.c | 2 +-
bsps/powerpc/shared/start/tictac.c | 2 +-
bsps/powerpc/shared/vme/doxygen.h | 6 ++++--
bsps/riscv/include/bsp/linker-symbols.h | 4 ++--
bsps/riscv/shared/doxygen.h | 8 ++++++++
bsps/shared/doxygen.h | 8 ++++++++
bsps/sparc/shared/doxygen.h | 14 ++++++-------
bsps/sparc/shared/start/bsp_fatal_exit.c | 2 +-
bsps/sparc/shared/start/bsp_fatal_halt.c | 2 +-
88 files changed, 263 insertions(+), 172 deletions(-)
diff --git a/bsps/arm/include/bsp/arm-a8core-start.h b/bsps/arm/include/bsp/arm-a8core-start.h
index 08311b4154..d9b7274018 100644
--- a/bsps/arm/include/bsp/arm-a8core-start.h
+++ b/bsps/arm/include/bsp/arm-a8core-start.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
*
* @brief A8CORE_START Support
*/
diff --git a/bsps/arm/include/bsp/arm-a9mpcore-irq.h b/bsps/arm/include/bsp/arm-a9mpcore-irq.h
index f0d3c1b983..1cc4cb0363 100644
--- a/bsps/arm/include/bsp/arm-a9mpcore-irq.h
+++ b/bsps/arm/include/bsp/arm-a9mpcore-irq.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
*
* @brief ARM_A9MPCORE_IRQ Support
*/
diff --git a/bsps/arm/include/bsp/arm-a9mpcore-regs.h b/bsps/arm/include/bsp/arm-a9mpcore-regs.h
index d1538357d8..74ec5e8559 100644
--- a/bsps/arm/include/bsp/arm-a9mpcore-regs.h
+++ b/bsps/arm/include/bsp/arm-a9mpcore-regs.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
*
* @brief ARM_A9MPCORE_REGS Support
*/
diff --git a/bsps/arm/include/bsp/arm-a9mpcore-start.h b/bsps/arm/include/bsp/arm-a9mpcore-start.h
index 5648dc0daf..8423e64e9d 100644
--- a/bsps/arm/include/bsp/arm-a9mpcore-start.h
+++ b/bsps/arm/include/bsp/arm-a9mpcore-start.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
*
* @brief A9MPCORE_START Support
*/
diff --git a/bsps/arm/include/bsp/arm-errata.h b/bsps/arm/include/bsp/arm-errata.h
index ae23dd5486..6a9292ab9d 100644
--- a/bsps/arm/include/bsp/arm-errata.h
+++ b/bsps/arm/include/bsp/arm-errata.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
*
* @brief Create #defines which state which erratas shall get applied
*/
diff --git a/bsps/arm/include/bsp/arm-gic.h b/bsps/arm/include/bsp/arm-gic.h
index 2abbea52cb..42d53284c0 100644
--- a/bsps/arm/include/bsp/arm-gic.h
+++ b/bsps/arm/include/bsp/arm-gic.h
@@ -34,7 +34,7 @@ extern "C" {
/**
* @defgroup arm_gic ARM GIC
*
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
*
* @brief ARM_GIC Support Package
*/
diff --git a/bsps/arm/include/bsp/arm-pl011-regs.h b/bsps/arm/include/bsp/arm-pl011-regs.h
index 2b930f4b4c..afe80a6262 100644
--- a/bsps/arm/include/bsp/arm-pl011-regs.h
+++ b/bsps/arm/include/bsp/arm-pl011-regs.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
*
* @brief ARM PL011 Register definitions
*/
diff --git a/bsps/arm/include/bsp/arm-pl011.h b/bsps/arm/include/bsp/arm-pl011.h
index 08189c477c..49ff413581 100644
--- a/bsps/arm/include/bsp/arm-pl011.h
+++ b/bsps/arm/include/bsp/arm-pl011.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
*
* @brief ARM PL011 Support Package
*/
diff --git a/bsps/arm/include/bsp/arm-pl050-regs.h b/bsps/arm/include/bsp/arm-pl050-regs.h
index f90aeb6cf9..1967d2e88d 100644
--- a/bsps/arm/include/bsp/arm-pl050-regs.h
+++ b/bsps/arm/include/bsp/arm-pl050-regs.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
*
* @brief ARM PL050 Register Definitions
*/
diff --git a/bsps/arm/include/bsp/arm-pl050.h b/bsps/arm/include/bsp/arm-pl050.h
index af4e246124..ad2dc0e1ec 100644
--- a/bsps/arm/include/bsp/arm-pl050.h
+++ b/bsps/arm/include/bsp/arm-pl050.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
*
* @brief ARM PL050 Support
*/
diff --git a/bsps/arm/include/bsp/arm-pl111-fb.h b/bsps/arm/include/bsp/arm-pl111-fb.h
index 0c8c6231e1..dddeda7168 100644
--- a/bsps/arm/include/bsp/arm-pl111-fb.h
+++ b/bsps/arm/include/bsp/arm-pl111-fb.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
*
* @brief ARM PL111 FB Support
*/
diff --git a/bsps/arm/include/bsp/arm-pl111-regs.h b/bsps/arm/include/bsp/arm-pl111-regs.h
index f351966775..49be17ea56 100644
--- a/bsps/arm/include/bsp/arm-pl111-regs.h
+++ b/bsps/arm/include/bsp/arm-pl111-regs.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
*
* @brief ARM PL111 Register definitions
*/
diff --git a/bsps/arm/include/bsp/arm-release-id.h b/bsps/arm/include/bsp/arm-release-id.h
index 45d5bd46cc..25bb9ee6f4 100644
--- a/bsps/arm/include/bsp/arm-release-id.h
+++ b/bsps/arm/include/bsp/arm-release-id.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
*
* @brief Create #defines for release IDs
*/
diff --git a/bsps/arm/include/bsp/armv7m-irq.h b/bsps/arm/include/bsp/armv7m-irq.h
index f91ab362e7..aa22bf8e2c 100644
--- a/bsps/arm/include/bsp/armv7m-irq.h
+++ b/bsps/arm/include/bsp/armv7m-irq.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
*
* @brief ARMV7M Support
*/
diff --git a/bsps/arm/include/bsp/linker-symbols.h b/bsps/arm/include/bsp/linker-symbols.h
index 135c85f215..d743f67f50 100644
--- a/bsps/arm/include/bsp/linker-symbols.h
+++ b/bsps/arm/include/bsp/linker-symbols.h
@@ -30,7 +30,7 @@ extern "C" {
/**
* @defgroup arm_linker Linker Support
*
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
*
* @brief Linker support.
*
diff --git a/bsps/arm/include/bsp/start.h b/bsps/arm/include/bsp/start.h
index bf8eed4433..0a5ce2ab62 100644
--- a/bsps/arm/include/bsp/start.h
+++ b/bsps/arm/include/bsp/start.h
@@ -34,7 +34,7 @@ extern "C" {
/**
* @defgroup arm_start System Start
*
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
*
* @brief ARM system low level start.
*
diff --git a/bsps/arm/shared/cache/cache-cp15.h b/bsps/arm/shared/cache/cache-cp15.h
index 1470c52e56..6ce85b692f 100644
--- a/bsps/arm/shared/cache/cache-cp15.h
+++ b/bsps/arm/shared/cache/cache-cp15.h
@@ -1,5 +1,5 @@
/**
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
*
* @brief Level 1 Cache definitions and functions.
*
diff --git a/bsps/arm/shared/cache/cache-l2c-310.c b/bsps/arm/shared/cache/cache-l2c-310.c
index e447aa0a63..7bfa1a564c 100644
--- a/bsps/arm/shared/cache/cache-l2c-310.c
+++ b/bsps/arm/shared/cache/cache-l2c-310.c
@@ -97,7 +97,7 @@
/**
* @defgroup L2C-310_cache Cache Support
- * @ingroup arm_shared
+ * @ingroup RTEMSBSPsARMShared
* @brief Cache Functions and Defitions
* @{
*/
diff --git a/bsps/arm/shared/doxygen.h b/bsps/arm/shared/doxygen.h
index 5c685c71c9..f8cb0135ef 100644
--- a/bsps/arm/shared/doxygen.h
+++ b/bsps/arm/shared/doxygen.h
@@ -6,10 +6,10 @@
* @brief ARM Board Support Packages.
*/
- /**
- * @defgroup arm_shared ARM Shared Modules
- *
- * @ingroup RTEMSBSPsARM
- *
- * @brief ARM Shared Modules
- */
+/**
+ * @defgroup RTEMSBSPsARMShared Shared
+ *
+ * @ingroup RTEMSBSPsARM
+ *
+ * @brief Shared Support for ARM Board Support Packages.
+ */
diff --git a/bsps/epiphany/include/bsp/linker-symbols.h b/bsps/epiphany/include/bsp/linker-symbols.h
index 50c5c38106..1a3d88ec8a 100644
--- a/bsps/epiphany/include/bsp/linker-symbols.h
+++ b/bsps/epiphany/include/bsp/linker-symbols.h
@@ -8,7 +8,7 @@ extern "C" {
/**
* @defgroup epiphany_linker Linker Support
*
- * @ingroup epiphany_shared
+ * @ingroup RTEMSBSPsEpiphanyShared
*
* @brief Linker support.
*
diff --git a/bsps/epiphany/shared/doxygen.h b/bsps/epiphany/shared/doxygen.h
index 2b7e54e053..2c33073078 100644
--- a/bsps/epiphany/shared/doxygen.h
+++ b/bsps/epiphany/shared/doxygen.h
@@ -5,3 +5,11 @@
*
* @brief Epiphany Board Support Packages.
*/
+
+/**
+ * @defgroup RTEMSBSPsEpiphanyShared Shared
+ *
+ * @ingroup RTEMSBSPsEpiphany
+ *
+ * @brief Shared Support for Epiphany Board Support Packages.
+ */
diff --git a/bsps/i386/include/bsp/irq.h b/bsps/i386/include/bsp/irq.h
index f7e673c8a7..50eacc97f0 100644
--- a/bsps/i386/include/bsp/irq.h
+++ b/bsps/i386/include/bsp/irq.h
@@ -24,7 +24,7 @@
/**
* @defgroup i386_irq Interrupt handlers
- * @ingroup i386_shared
+ * @ingroup RTEMSBSPsI386
* @brief Data structure and the functions to write interrupt handlers
* @{
*/
diff --git a/bsps/i386/include/bsp/realmode_int.h b/bsps/i386/include/bsp/realmode_int.h
index 6d246e3c91..fdac86c9bb 100644
--- a/bsps/i386/include/bsp/realmode_int.h
+++ b/bsps/i386/include/bsp/realmode_int.h
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup i386_shared
+ * @ingroup RTEMSBSPsI386
*
* @brief Definitioins supporting real mode interrupt calls.
*
diff --git a/bsps/i386/include/bsp/smp-imps.h b/bsps/i386/include/bsp/smp-imps.h
index 60e688547b..03434b81ef 100644
--- a/bsps/i386/include/bsp/smp-imps.h
+++ b/bsps/i386/include/bsp/smp-imps.h
@@ -60,7 +60,7 @@
/**
* @defgroup i386_smp SMP
- * @ingroup i386_shared
+ * @ingroup RTEMSBSPsI386
* @brief
* Header file implementing Intel MultiProcessor Specification (MPS)
* version 1.1 and 1.4 SMP hardware control for Intel Architecture CPUs,
diff --git a/bsps/i386/pc386/start/realmode_int.c b/bsps/i386/pc386/start/realmode_int.c
index bbabe189c6..a6db9efe1b 100644
--- a/bsps/i386/pc386/start/realmode_int.c
+++ b/bsps/i386/pc386/start/realmode_int.c
@@ -1,7 +1,7 @@
/**
* @file
*
- * @ingroup i386_shared
+ * @ingroup RTEMSBSPsI386
*
* @brief Real mode interrupt call implementation
*/
diff --git a/bsps/i386/shared/doxygen.h b/bsps/i386/shared/doxygen.h
index 01af22ca5e..f38008e6cd 100644
--- a/bsps/i386/shared/doxygen.h
+++ b/bsps/i386/shared/doxygen.h
@@ -6,20 +6,14 @@
* @brief i386 Board Support Package.
*/
-/**
- * @defgroup i386_shared i386 Shared Modules
- * @ingroup bsp_i386
- * @brief i386 Shared Modules
- */
-
/**
* @defgroup i386_comm Comm
- * @ingroup i386_shared
+ * @ingroup RTEMSBSPsI386
* @brief Comm
*/
/**
* @defgroup i386_pci PCI
- * @ingroup i386_shared
+ * @ingroup RTEMSBSPsI386
* @brief PCI
*/
diff --git a/bsps/include/bsp/console-termios.h b/bsps/include/bsp/console-termios.h
index 413dde4663..31132f45f3 100644
--- a/bsps/include/bsp/console-termios.h
+++ b/bsps/include/bsp/console-termios.h
@@ -24,7 +24,7 @@ extern "C" {
/**
* @defgroup ConsoleTermios Termios Console Driver
*
- * @ingroup TermiostypesSupport
+ * @ingroup RTEMSBSPsSharedConsole
*
* @brief Console driver for Termios devices.
*
diff --git a/bsps/include/bsp/default-initial-extension.h b/bsps/include/bsp/default-initial-extension.h
index 1c795b7278..cdad76edaa 100644
--- a/bsps/include/bsp/default-initial-extension.h
+++ b/bsps/include/bsp/default-initial-extension.h
@@ -32,7 +32,7 @@ extern "C" {
/**
* @defgroup shared_defaultinitialextension DEFAULT_INITIAL_EXTENSION Support
*
- * @ingroup shared_include
+ * @ingroup RTEMSBSPsShared
*
* @brief DEFAULT_INITIAL_EXTENSION Support Package
*/
diff --git a/bsps/include/bsp/u-boot.h b/bsps/include/bsp/u-boot.h
index 0f567c1850..8bcb1488a4 100644
--- a/bsps/include/bsp/u-boot.h
+++ b/bsps/include/bsp/u-boot.h
@@ -45,7 +45,7 @@ extern bd_t bsp_uboot_board_info;
/**
* @defgroup shared_uboot U_BOOT Support
*
- * @ingroup shared_include
+ * @ingroup RTEMSBSPsShared
*
* @brief U_BOOT Support Package
*/
diff --git a/bsps/include/grlib/ambapp.h b/bsps/include/grlib/ambapp.h
index 5e5a649f53..6b617ada70 100644
--- a/bsps/include/grlib/ambapp.h
+++ b/bsps/include/grlib/ambapp.h
@@ -1,9 +1,6 @@
/**
* @file
- * @ingroup sparc_bsp
- * @defgroup amba AMBA
* @ingroup amba
- * @brief AMBA Plug &Play routines
*/
/*
@@ -18,6 +15,16 @@
#ifndef __AMBAPP_H__
#define __AMBAPP_H__
+/**
+ * @defgroup amba AMBA
+ *
+ * @ingroup RTEMSBSPsSharedGRLIB
+ *
+ * @brief AMBA Plug & Play routines
+ *
+ * @{
+ */
+
/* Include VENDOR and DEVICE definitions */
#include "ambapp_ids.h"
@@ -373,4 +380,6 @@ extern int ambapp_get_number_apbslv_devices(
}
#endif
+/** @} */
+
#endif
diff --git a/bsps/include/grlib/apbuart.h b/bsps/include/grlib/apbuart.h
index 6a89bb949a..2b68808ed5 100644
--- a/bsps/include/grlib/apbuart.h
+++ b/bsps/include/grlib/apbuart.h
@@ -1,9 +1,6 @@
/**
* @file
- * @ingroup sparc_bsp
- * @defgroup uart UART
* @ingroup uart
- * @brief Driver interface for APBUART
*/
/*
@@ -19,6 +16,16 @@
#ifndef __APBUART_H__
#define __APBUART_H__
+/**
+ * @defgroup uart UART
+ *
+ * @ingroup RTEMSBSPsSharedGRLIB
+ *
+ * @brief Driver interface for APBUART
+ *
+ * @{
+ */
+
#include "ambapp.h"
#include "grlib.h"
@@ -68,4 +75,6 @@ int apbuart_inbyte_nonblocking(struct apbuart_regs *regs);
}
#endif
+/** @} */
+
#endif /* __APBUART_H__ */
diff --git a/bsps/include/grlib/b1553brm.h b/bsps/include/grlib/b1553brm.h
index eba0716f75..bb7294de43 100644
--- a/bsps/include/grlib/b1553brm.h
+++ b/bsps/include/grlib/b1553brm.h
@@ -1,9 +1,6 @@
/**
* @file
- * @ingroup sparc_bsp
- * @defgroup 1553 B1553BRM
* @ingroup 1553
- * @brief B1553BRM device driver
*/
/*
@@ -18,6 +15,16 @@
#ifndef __B1553BRM_H__
#define __B1553BRM_H__
+/**
+ * @defgroup 1553 B1553BRM
+ *
+ * @ingroup RTEMSBSPsSharedGRLIB
+ *
+ * @brief B1553BRM device driver
+ *
+ * @{
+ */
+
#include <drvmgr/drvmgr.h>
#ifdef __cplusplus
@@ -174,5 +181,7 @@ void b1553brm_print_dev(struct drvmgr_dev *dev, int options);
}
#endif
+/** @} */
+
#endif /* __BRM_H__ */
diff --git a/bsps/include/grlib/debug_defs.h b/bsps/include/grlib/debug_defs.h
index 58f7460f52..6425bd6f01 100644
--- a/bsps/include/grlib/debug_defs.h
+++ b/bsps/include/grlib/debug_defs.h
@@ -1,9 +1,6 @@
/**
* @file
- * @ingroup bsp_kit
- * @defgroup sparc_bsp SPARC
- * @ingroup sparc_bsp
- * @brief Debug Definitions
+ * @ingroup RTEMSBSPsSharedGRLIB
*/
#ifndef __DEBUG_DEFS_H__
diff --git a/bsps/include/grlib/grcan.h b/bsps/include/grlib/grcan.h
index 5cdbad4b01..b1bc2ba758 100644
--- a/bsps/include/grlib/grcan.h
+++ b/bsps/include/grlib/grcan.h
@@ -1,9 +1,6 @@
/**
* @file
- * @ingroup sparc_bsp
- * @defgroup can GRCAN
* @ingroup can
- * @brief Macros used for grcan controller
*/
/*
@@ -18,6 +15,16 @@
#ifndef __GRCAN_H__
#define __GRCAN_H__
+/**
+ * @defgroup can GRCAN
+ *
+ * @ingroup RTEMSBSPsSharedGRLIB
+ *
+ * @brief Macros used for grcan controller
+ *
+ * @{
+ */
+
#ifdef __cplusplus
extern "C" {
#endif
@@ -339,4 +346,6 @@ void grcan_register_drv(void);
}
#endif
+/** @} */
+
#endif
diff --git a/bsps/include/grlib/grlib.h b/bsps/include/grlib/grlib.h
index a2d0877fb8..fb7085dfc4 100644
--- a/bsps/include/grlib/grlib.h
+++ b/bsps/include/grlib/grlib.h
@@ -20,6 +20,14 @@
extern "C" {
#endif
+/**
+ * @defgroup RTEMSBSPsSharedGRLIB GRLIB
+ *
+ * @ingroup RTEMSBSPsShared
+ *
+ * @brief Driver support for GRLIB IP Library.
+ */
+
/* ESA MEMORY CONTROLLER */
struct mctrl_regs {
unsigned int mcfg1;
diff --git a/bsps/include/grlib/grspw.h b/bsps/include/grlib/grspw.h
index 70a9e0b100..50ca744bde 100644
--- a/bsps/include/grlib/grspw.h
+++ b/bsps/include/grlib/grspw.h
@@ -1,9 +1,6 @@
/**
* @file
- * @ingroup sparc_bsp
- * @defgroup spw SpaceWire
* @ingroup spw
- * @brief GRSPW Device Driver
*/
/*
@@ -18,6 +15,16 @@
#ifndef __GRSPW_H__
#define __GRSPW_H__
+/**
+ * @defgroup spw SpaceWire
+ *
+ * @ingroup RTEMSBSPsSharedGRLIB
+ *
+ * @brief GRSPW Device Driver
+ *
+ * @{
+ */
+
#include <grlib/ambapp.h>
#ifdef __cplusplus
@@ -165,4 +172,6 @@ extern void (*grspw_timecode_callback)
}
#endif
+/** @} */
+
#endif /* __GRSPW_H__ */
diff --git a/bsps/include/grlib/i2cmst.h b/bsps/include/grlib/i2cmst.h
index a06117f0dc..01dbcf5bfb 100644
--- a/bsps/include/grlib/i2cmst.h
+++ b/bsps/include/grlib/i2cmst.h
@@ -1,9 +1,6 @@
/**
* @file
- * @ingroup sparc_bsp
- * @defgroup i2c I2C-master
* @ingroup i2c
- * @brief Driver for GRLIB port of OpenCores I2C-master
*/
/*
@@ -18,6 +15,16 @@
#ifndef _I2CMST_H
#define _I2CMST_H
+/**
+ * @defgroup i2c I2C-master
+ *
+ * @ingroup RTEMSBSPsSharedGRLIB
+ *
+ * @brief Driver for GRLIB port of OpenCores I2C-master
+ *
+ * @{
+ */
+
#include <rtems/libi2c.h>
#include "ambapp.h"
@@ -62,4 +69,6 @@ void i2cmst_register_drv (void);
}
#endif
+/** @} */
+
#endif /* _I2CMST_H */
diff --git a/bsps/lm32/include/bsp/milkymist_ac97.h b/bsps/lm32/include/bsp/milkymist_ac97.h
index 37415a1f5e..d3b0b9d53d 100644
--- a/bsps/lm32/include/bsp/milkymist_ac97.h
+++ b/bsps/lm32/include/bsp/milkymist_ac97.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_milkymist_ac97 lm32_milkymist_shared
+ * @ingroup lm32_milkymist_ac97 RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist AC97 driver
*/
@@ -17,7 +17,7 @@
/**
* @defgroup lm32_milkymist_ac97 Milkymist AC97
- * @ingroup lm32_milkymist_shared
+ * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist AC97 driver
* @{
*/
diff --git a/bsps/lm32/include/bsp/milkymist_buttons.h b/bsps/lm32/include/bsp/milkymist_buttons.h
index de6ee51438..4b93d7a9f4 100644
--- a/bsps/lm32/include/bsp/milkymist_buttons.h
+++ b/bsps/lm32/include/bsp/milkymist_buttons.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_milkymist_buttons lm32_milkymist_shared
+ * @ingroup lm32_milkymist_buttons RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist buttons driver
*/
@@ -17,7 +17,7 @@
/**
* @defgroup lm32_milkymist_buttons Milkymist buttons
- * @ingroup lm32_milkymist_shared
+ * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist buttons driver
* @{
*/
diff --git a/bsps/lm32/include/bsp/milkymist_dmx.h b/bsps/lm32/include/bsp/milkymist_dmx.h
index a933e3423f..d00b6d52a6 100644
--- a/bsps/lm32/include/bsp/milkymist_dmx.h
+++ b/bsps/lm32/include/bsp/milkymist_dmx.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_milkymist_dmx lm32_milkymist_shared
+ * @ingroup lm32_milkymist_dmx RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist DMX512 driver
*/
@@ -17,7 +17,7 @@
/**
* @defgroup lm32_milkymist_dmx Milkymist DMX512
- * @ingroup lm32_milkymist_shared
+ * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist DMX512 driver
* @{
*/
diff --git a/bsps/lm32/include/bsp/milkymist_flash.h b/bsps/lm32/include/bsp/milkymist_flash.h
index 2acf855096..5b71872342 100644
--- a/bsps/lm32/include/bsp/milkymist_flash.h
+++ b/bsps/lm32/include/bsp/milkymist_flash.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_milkymist_flash lm32_milkymist_shared
+ * @ingroup lm32_milkymist_flash RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist Flash
*/
@@ -16,7 +16,7 @@
/**
* @defgroup lm32_milkymist_flash Milkymist Flash
- * @ingroup lm32_milkymist_shared
+ * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist Flash
* @{
*/
diff --git a/bsps/lm32/include/bsp/milkymist_gpio.h b/bsps/lm32/include/bsp/milkymist_gpio.h
index 1e30b9c280..37d84d7c90 100644
--- a/bsps/lm32/include/bsp/milkymist_gpio.h
+++ b/bsps/lm32/include/bsp/milkymist_gpio.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_milkymist_gpio lm32_milkymist_shared
+ * @ingroup lm32_milkymist_gpio RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist GPIO driver
*/
@@ -17,7 +17,7 @@
/**
* @defgroup lm32_milkymist_gpio Milkymist GPIO
- * @ingroup lm32_milkymist_shared
+ * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist GPIO driver
* @{
*/
diff --git a/bsps/lm32/include/bsp/milkymist_ir.h b/bsps/lm32/include/bsp/milkymist_ir.h
index 4df7f3550c..ea5ee273c6 100644
--- a/bsps/lm32/include/bsp/milkymist_ir.h
+++ b/bsps/lm32/include/bsp/milkymist_ir.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_milkymist_ir lm32_milkymist_shared
+ * @ingroup lm32_milkymist_ir RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist RC5 IR driver
*/
@@ -17,7 +17,7 @@
/**
* @defgroup lm32_milkymist_ir Milkymist IR
- * @ingroup lm32_milkymist_shared
+ * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist RC5 IR driver
* @{
*/
diff --git a/bsps/lm32/include/bsp/milkymist_memcard.h b/bsps/lm32/include/bsp/milkymist_memcard.h
index 713b45be07..e189a93ac5 100644
--- a/bsps/lm32/include/bsp/milkymist_memcard.h
+++ b/bsps/lm32/include/bsp/milkymist_memcard.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_milkymist_memcard lm32_milkymist_shared
+ * @ingroup lm32_milkymist_memcard RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist memory card driver
*/
@@ -17,7 +17,7 @@
/**
* @defgroup lm32_milkymist_memcard Milkymist memory card
- * @ingroup lm32_milkymist_shared
+ * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist memory card driver
* @{
*/
diff --git a/bsps/lm32/include/bsp/milkymist_midi.h b/bsps/lm32/include/bsp/milkymist_midi.h
index da53de6af5..1a17292d72 100644
--- a/bsps/lm32/include/bsp/milkymist_midi.h
+++ b/bsps/lm32/include/bsp/milkymist_midi.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_milkymist_midi lm32_milkymist_shared
+ * @ingroup lm32_milkymist_midi RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist MIDI driver
*/
@@ -17,7 +17,7 @@
/**
* @defgroup lm32_milkymist_midi Milkymist MIDI
- * @ingroup lm32_milkymist_shared
+ * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist MIDI driver
* @{
*/
diff --git a/bsps/lm32/include/bsp/milkymist_pfpu.h b/bsps/lm32/include/bsp/milkymist_pfpu.h
index 73ea5fa28e..d2c749806f 100644
--- a/bsps/lm32/include/bsp/milkymist_pfpu.h
+++ b/bsps/lm32/include/bsp/milkymist_pfpu.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_milkymist_pfpu lm32_milkymist_shared
+ * @ingroup lm32_milkymist_pfpu RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist PFPU driver
*/
@@ -17,7 +17,7 @@
/**
* @defgroup lm32_milkymist_pfpu Milkymist PFPU
- * @ingroup lm32_milkymist_shared
+ * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist PFPU driver
* @{
*/
diff --git a/bsps/lm32/include/bsp/milkymist_tmu.h b/bsps/lm32/include/bsp/milkymist_tmu.h
index 94f8394ef7..b3f7c23760 100644
--- a/bsps/lm32/include/bsp/milkymist_tmu.h
+++ b/bsps/lm32/include/bsp/milkymist_tmu.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_milkymist_tmu lm32_milkymist_shared
+ * @ingroup lm32_milkymist_tmu RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist TMU driver
*/
@@ -17,7 +17,7 @@
/**
* @defgroup lm32_milkymist_tmu Milkymist TMU
- * @ingroup lm32_milkymist_shared
+ * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist TMU driver
* @{
*/
diff --git a/bsps/lm32/include/bsp/milkymist_usbinput.h b/bsps/lm32/include/bsp/milkymist_usbinput.h
index 04c376fa8a..ee4ec337e9 100644
--- a/bsps/lm32/include/bsp/milkymist_usbinput.h
+++ b/bsps/lm32/include/bsp/milkymist_usbinput.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_milkymist_usbinput lm32_milkymist_shared
+ * @ingroup lm32_milkymist_usbinput RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist USB input devices driver
*/
@@ -17,7 +17,7 @@
/**
* @defgroup lm32_milkymist_usbinput Milkymist USB input devices
- * @ingroup lm32_milkymist_shared
+ * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist USB input devices driver
* @{
*/
diff --git a/bsps/lm32/include/bsp/milkymist_versions.h b/bsps/lm32/include/bsp/milkymist_versions.h
index 3b5063f306..058f0ae0d8 100644
--- a/bsps/lm32/include/bsp/milkymist_versions.h
+++ b/bsps/lm32/include/bsp/milkymist_versions.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_milkymist_versions lm32_milkymist_shared
+ * @ingroup lm32_milkymist_versions RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist versioning driver
*/
@@ -17,7 +17,7 @@
/**
* @defgroup lm32_milkymist_versions Milkymist versioning
- * @ingroup lm32_milkymist_shared
+ * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist versioning driver
* @{
*/
diff --git a/bsps/lm32/include/bsp/milkymist_video.h b/bsps/lm32/include/bsp/milkymist_video.h
index 6ec3cc0a83..ba4cd89ae7 100644
--- a/bsps/lm32/include/bsp/milkymist_video.h
+++ b/bsps/lm32/include/bsp/milkymist_video.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_milkymist_video lm32_milkymist_shared
+ * @ingroup lm32_milkymist_video RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist video input driver
*/
@@ -17,7 +17,7 @@
/**
* @defgroup lm32_milkymist_video Milkymist Video
- * @ingroup lm32_milkymist_shared
+ * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist video input driver
* @{
*/
diff --git a/bsps/lm32/shared/clock/clock.h b/bsps/lm32/shared/clock/clock.h
index 255585475a..fa61e1d58e 100644
--- a/bsps/lm32/shared/clock/clock.h
+++ b/bsps/lm32/shared/clock/clock.h
@@ -20,7 +20,7 @@
/**
* @defgroup lm32_clock LM32 Clock
- * @ingroup lm32_shared
+ * @ingroup RTEMSBSPsLM32Shared
* @brief LatticeMico32 Timer (Clock) definitions.
* @{
*/
diff --git a/bsps/lm32/shared/console/uart.h b/bsps/lm32/shared/console/uart.h
index baafde13e2..6a3706a537 100644
--- a/bsps/lm32/shared/console/uart.h
+++ b/bsps/lm32/shared/console/uart.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_shared lm32_uart
+ * @ingroup RTEMSBSPsLM32Shared lm32_uart
* @brief LatticeMico32 UART definitions
*/
@@ -20,7 +20,7 @@
/**
* @defgroup lm32_uart LM32 UART
- * @ingroup lm32_shared
+ * @ingroup RTEMSBSPsLM32Shared
* @brief LatticeMico32 UART definitions
* @{
*/
diff --git a/bsps/lm32/shared/doxygen.h b/bsps/lm32/shared/doxygen.h
index ace1205502..73584e9293 100644
--- a/bsps/lm32/shared/doxygen.h
+++ b/bsps/lm32/shared/doxygen.h
@@ -6,18 +6,18 @@
* @brief LatticeMicro32 Board Support Packages.
*/
- /**
- * @defgroup lm32_shared Lattice Mico32 Shared Modules
- *
- * @ingroup RTEMSBSPsLM32
- *
- * @brief Lattice Mico32 Shared Modules
- */
+/**
+ * @defgroup RTEMSBSPsLM32Shared Shared
+ *
+ * @ingroup RTEMSBSPsLM32
+ *
+ * @brief Shared Support for LatticeMicro32 Board Support Packages.
+ */
- /**
- * @defgroup lm32_milkymist_shared LM32 Milkymist One
- *
- * @ingroup lm32_shared
- *
- * @brief Lattice Mico32 Milkymist One
- */
+/**
+ * @defgroup RTEMSBSPsLM32SharedMilkymistOne Milkymist One
+ *
+ * @ingroup RTEMSBSPsLM32Shared
+ *
+ * @brief Shared Support for Milkymist One Board Support Packages.
+ */
diff --git a/bsps/lm32/shared/gdbstub/gdb_if.h b/bsps/lm32/shared/gdbstub/gdb_if.h
index 6df9c8e921..bfc62a771b 100644
--- a/bsps/lm32/shared/gdbstub/gdb_if.h
+++ b/bsps/lm32/shared/gdbstub/gdb_if.h
@@ -20,7 +20,7 @@
/**
* @defgroup lm32_gdb LM32 GDB Interface
- * @ingroup lm32_shared
+ * @ingroup RTEMSBSPsLM32Shared
* @brief Definition of the interface between the stub and gdb,
* @{
*/
diff --git a/bsps/lm32/shared/milkymist_clock/clock.h b/bsps/lm32/shared/milkymist_clock/clock.h
index 96dc2efbf6..0df1217ccf 100644
--- a/bsps/lm32/shared/milkymist_clock/clock.h
+++ b/bsps/lm32/shared/milkymist_clock/clock.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_clock lm32_milkymist_shared
+ * @ingroup lm32_clock RTEMSBSPsLM32SharedMilkymistOne
* @brief LatticeMico32 Timer (Clock) definitions
*/
diff --git a/bsps/lm32/shared/milkymist_console/uart.h b/bsps/lm32/shared/milkymist_console/uart.h
index 5dbb8cd859..0dbb22b6e1 100644
--- a/bsps/lm32/shared/milkymist_console/uart.h
+++ b/bsps/lm32/shared/milkymist_console/uart.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_uart lm32_milkymist_shared
+ * @ingroup lm32_uart RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist UART definitions
*/
diff --git a/bsps/lm32/shared/milkymist_usbinput/comloc.h b/bsps/lm32/shared/milkymist_usbinput/comloc.h
index 187792f348..211be0b8fa 100644
--- a/bsps/lm32/shared/milkymist_usbinput/comloc.h
+++ b/bsps/lm32/shared/milkymist_usbinput/comloc.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_milkymist_usbinput lm32_milkymist_shared
+ * @ingroup lm32_milkymist_usbinput RTEMSBSPsLM32SharedMilkymistOne
* @brief Milkymist USB input devices driver
*/
diff --git a/bsps/lm32/shared/net/network.h b/bsps/lm32/shared/net/network.h
index 7961c8413c..6d81d30907 100644
--- a/bsps/lm32/shared/net/network.h
+++ b/bsps/lm32/shared/net/network.h
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup lm32_milkymist_network lm32_milkymist_shared
+ * @ingroup lm32_milkymist_network RTEMSBSPsLM32SharedMilkymistOne
* @brief Driver for Minimac ethernet
*/
@@ -18,7 +18,7 @@
/**
* @defgroup lm32_milkymist_network Minimac ethernet driver
- * @ingroup lm32_milkymist_shared
+ * @ingroup RTEMSBSPsLM32SharedMilkymistOne
* @brief Driver for Minimac ethernet IP-core of Milkymist SoC
* @{
*/
diff --git a/bsps/lm32/shared/net/tsmac.h b/bsps/lm32/shared/net/tsmac.h
index bb2d3b4451..ee7a7a145b 100644
--- a/bsps/lm32/shared/net/tsmac.h
+++ b/bsps/lm32/shared/net/tsmac.h
@@ -20,7 +20,7 @@
/**
* @defgroup lm32_tsmac LM32 TSMAC
- * @ingroup lm32_shared
+ * @ingroup RTEMSBSPsLM32Shared
* @brief LatticeMico32 TSMAC (Tri-Speed MAC) definitions.
* @{
*/
diff --git a/bsps/m68k/include/bsp/linker-symbols.h b/bsps/m68k/include/bsp/linker-symbols.h
index 8bf5ebfa07..56c9c67762 100644
--- a/bsps/m68k/include/bsp/linker-symbols.h
+++ b/bsps/m68k/include/bsp/linker-symbols.h
@@ -28,9 +28,9 @@ extern "C" {
#endif /* __cplusplus */
/**
- * @defgroup bsp_linker Linker Support
+ * @defgroup RTEMSBSPsM68kSharedLinker Linker Support
*
- * @ingroup bsp_kit
+ * @ingroup RTEMSBSPsM68kShared
*
* @brief Linker support.
*
diff --git a/bsps/m68k/include/mvme16x_hw.h b/bsps/m68k/include/mvme16x_hw.h
index 2ac595a0fa..305bacab7d 100644
--- a/bsps/m68k/include/mvme16x_hw.h
+++ b/bsps/m68k/include/mvme16x_hw.h
@@ -32,7 +32,7 @@ extern "C" {
/**
* @defgroup m68k_mvme MVME16X IO Support
*
- * @ingroup m68k_shared
+ * @ingroup RTEMSBSPsM68kShared
*
* @brief IO Support Package
*/
diff --git a/bsps/m68k/shared/doxygen.h b/bsps/m68k/shared/doxygen.h
index 6cf60f2252..573ec104ec 100644
--- a/bsps/m68k/shared/doxygen.h
+++ b/bsps/m68k/shared/doxygen.h
@@ -3,13 +3,13 @@
*
* @ingroup RTEMSBSPs
*
- * @brief Motorola 68000 and NXP ColdFire Board Support Packagess.
+ * @brief Motorola 68000 and NXP ColdFire Board Support Packages.
*/
/**
- * @defgroup m68k_shared M68K Shared Modules
- *
- * @ingroup RTEMSBSPsM68k
- *
- * @brief M68K Shared Modules
- */
+ * @defgroup RTEMSBSPsM68kShared Shared
+ *
+ * @ingroup RTEMSBSPsM68k
+ *
+ * @brief Shared Support for Motorola 68000 and NXP ColdFire Board Support Packages.
+ */
diff --git a/bsps/m68k/shared/gdbstub/gdb_if.h b/bsps/m68k/shared/gdbstub/gdb_if.h
index 6c68703b76..73bace2b3f 100644
--- a/bsps/m68k/shared/gdbstub/gdb_if.h
+++ b/bsps/m68k/shared/gdbstub/gdb_if.h
@@ -24,7 +24,7 @@
/**
* @defgroup m68k_gdbstub GDB Stub
*
- * @ingroup m68k_shared
+ * @ingroup RTEMSBSPsM68kShared
*
* @brief GDB Stub interface support
*/
diff --git a/bsps/mips/include/bsp/i8259.h b/bsps/mips/include/bsp/i8259.h
index 8d10523b40..1a947829b0 100644
--- a/bsps/mips/include/bsp/i8259.h
+++ b/bsps/mips/include/bsp/i8259.h
@@ -27,7 +27,7 @@
/**
* @defgroup mips_i8259_irq i8259 Chip Support
- * @ingroup mips_shared
+ * @ingroup RTEMSBSPsMIPSShared
* @brief i8259 Chip Support
* @{
*/
diff --git a/bsps/mips/include/bsp/regs.h b/bsps/mips/include/bsp/regs.h
index 5cc9fac745..6b6eca063b 100644
--- a/bsps/mips/include/bsp/regs.h
+++ b/bsps/mips/include/bsp/regs.h
@@ -22,7 +22,7 @@
/**
* @defgroup mips_regs MIPS Registers
- * @ingroup mips_shared
+ * @ingroup RTEMSBSPsMIPSShared
* @brief MIPS Registers
* @{
*/
diff --git a/bsps/mips/shared/doxygen.h b/bsps/mips/shared/doxygen.h
index 439f0b82a5..ee699fb556 100644
--- a/bsps/mips/shared/doxygen.h
+++ b/bsps/mips/shared/doxygen.h
@@ -6,8 +6,10 @@
* @brief MIPS Board Support Packages.
*/
- /**
- * @defgroup mips_shared MIPS Shared Modules
- * @ingroup RTEMSBSPsMIPS
- * @brief mips Shared Modules
- */
+/**
+ * @defgroup RTEMSBSPsMIPSShared Shared
+ *
+ * @ingroup RTEMSBSPsMIPS
+ *
+ * @brief Shared Support for MIPS Board Support Packages.
+ */
diff --git a/bsps/mips/shared/gdbstub/gdb_if.h b/bsps/mips/shared/gdbstub/gdb_if.h
index ba4f0eb757..b9d96a9744 100644
--- a/bsps/mips/shared/gdbstub/gdb_if.h
+++ b/bsps/mips/shared/gdbstub/gdb_if.h
@@ -20,7 +20,7 @@
/**
* @defgroup mips_gdb GDB Interface
- * @ingroup mips_shared
+ * @ingroup RTEMSBSPsMIPSShared
* @brief GDB Interface
* @{
*/
diff --git a/bsps/mips/shared/gdbstub/memlimits.h b/bsps/mips/shared/gdbstub/memlimits.h
index c60ca12111..7466917267 100644
--- a/bsps/mips/shared/gdbstub/memlimits.h
+++ b/bsps/mips/shared/gdbstub/memlimits.h
@@ -53,7 +53,7 @@
/**
* @defgroup mips_limits Address Limits
- * @ingroup mips_shared
+ * @ingroup RTEMSBSPsMIPSShared
* @brief Address Limits
*/
diff --git a/bsps/mips/shared/gdbstub/mips_opcode.h b/bsps/mips/shared/gdbstub/mips_opcode.h
index 883b1f174b..e9fe2177ff 100644
--- a/bsps/mips/shared/gdbstub/mips_opcode.h
+++ b/bsps/mips/shared/gdbstub/mips_opcode.h
@@ -53,7 +53,7 @@
/**
* @defgroup mips_ops MIPS Opcodes
- * @ingroup mips_shared
+ * @ingroup RTEMSBSPsMIPSShared
* @brief MIPS Instruction Formats and Opcode Values
* @{
*/
diff --git a/bsps/or1k/include/bsp/linker-symbols.h b/bsps/or1k/include/bsp/linker-symbols.h
index f0f8377892..cf513a347c 100644
--- a/bsps/or1k/include/bsp/linker-symbols.h
+++ b/bsps/or1k/include/bsp/linker-symbols.h
@@ -6,9 +6,9 @@ extern "C" {
#endif /* __cplusplus */
/**
- * @defgroup or1k_linker Linker Support
+ * @defgroup RTEMSBSPsOR1KSharedLinker Linker Support
*
- * @ingroup or1k_shared
+ * @ingroup RTEMSBSPsOR1K
*
* @brief Linker support.
*
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
*/
diff --git a/bsps/riscv/include/bsp/linker-symbols.h b/bsps/riscv/include/bsp/linker-symbols.h
index 05e633921c..f9deda00f2 100644
--- a/bsps/riscv/include/bsp/linker-symbols.h
+++ b/bsps/riscv/include/bsp/linker-symbols.h
@@ -6,9 +6,9 @@ extern "C" {
#endif /* __cplusplus */
/**
- * @defgroup riscv_linker Linker Support
+ * @defgroup RTEMSBSPsRISCVSharedLinker Linker Support
*
- * @ingroup riscv_shared
+ * @ingroup RTEMSBSPsRISCVShared
*
* @brief Linker support.
*
diff --git a/bsps/riscv/shared/doxygen.h b/bsps/riscv/shared/doxygen.h
index c7712eefca..dc95013d05 100644
--- a/bsps/riscv/shared/doxygen.h
+++ b/bsps/riscv/shared/doxygen.h
@@ -5,3 +5,11 @@
*
* @brief RISC-V Board Support Packages.
*/
+
+/**
+ * @defgroup RTEMSBSPsRISCVShared Shared
+ *
+ * @ingroup RTEMSBSPsRISCV
+ *
+ * @brief Shared Support for RISC-V Board Support Packages.
+ */
diff --git a/bsps/shared/doxygen.h b/bsps/shared/doxygen.h
index 538ed9e8b1..28bd4990f7 100644
--- a/bsps/shared/doxygen.h
+++ b/bsps/shared/doxygen.h
@@ -12,3 +12,11 @@
*
* @brief Shared Support for Board Support Packages
*/
+
+/**
+ * @defgroup RTEMSBSPsSharedConsole Console Driver Support
+ *
+ * @ingroup RTEMSBSPsShared
+ *
+ * @brief Console Driver Support for Board Support Packages.
+ */
diff --git a/bsps/sparc/shared/doxygen.h b/bsps/sparc/shared/doxygen.h
index a5907d281c..100a9b6c18 100644
--- a/bsps/sparc/shared/doxygen.h
+++ b/bsps/sparc/shared/doxygen.h
@@ -6,10 +6,10 @@
* @brief SPARC Board Support Packages.
*/
- /**
- * @defgroup sparc_shared SPARC Shared Modules
- *
- * @ingroup RTEMSBSPsSPARC
- *
- * @brief SPARC Shared Modules
- */
+/**
+ * @defgroup RTEMSBSPsSPARCShared Shared
+ *
+ * @ingroup RTEMSBSPsSPARC
+ *
+ * @brief Shared Support for SPARC Board Support Packages.
+ */
diff --git a/bsps/sparc/shared/start/bsp_fatal_exit.c b/bsps/sparc/shared/start/bsp_fatal_exit.c
index 8b64125c93..2ad11846e5 100644
--- a/bsps/sparc/shared/start/bsp_fatal_exit.c
+++ b/bsps/sparc/shared/start/bsp_fatal_exit.c
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup sparc_bsp
+ * @ingroup RTEMSBSPsSPARCShared
* @brief ERC32/LEON2/LEON3 BSP specific exit handler.
*/
diff --git a/bsps/sparc/shared/start/bsp_fatal_halt.c b/bsps/sparc/shared/start/bsp_fatal_halt.c
index f32ddaafc0..3a82445ac1 100644
--- a/bsps/sparc/shared/start/bsp_fatal_halt.c
+++ b/bsps/sparc/shared/start/bsp_fatal_halt.c
@@ -1,6 +1,6 @@
/**
* @file
- * @ingroup sparc_bsp
+ * @ingroup RTEMSBSPsSPARCShared
* @brief ERC32/LEON2 BSP Fatal_halt handler.
*
* COPYRIGHT (c) 2014.
--
2.16.4
More information about the devel
mailing list