bsps: Adjust shared Doxygen groups

Update #3706.
2019-03-05 07:58:18 +01:00
parent c991eeeccc
commit 828276b081
88 changed files with 263 additions and 172 deletions
--- 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.
 * @{
 */
--- 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
 * @{
 */
--- 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.
+ */
--- 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,
 * @{
 */
--- 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
 */

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

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

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