From 2d6543d4c84cc896b7ff357772ea02472d49d882 Mon Sep 17 00:00:00 2001
From: Daniel Ramirez <javamonn@gmail.com>
Date: Fri, 29 Nov 2013 20:18:44 -0600
Subject: doxygen: refactored doxygen in libbsp/arm/lpc32xx

This patch refactors a lot of the existing doxygen within libbsp/arm/lpc32xx.
Much of this refactoring was just renaming of existing groups to conform to a
more consistent naming structure. With the addition of a doxygen header for
tm27.h, all files within lpc32xx belong to doxygen group now. lpc32xx should
be used a reference for adding doxygen to other bsps.
---
 c/src/lib/libbsp/arm/lpc32xx/console/console-config.c | 2 +-
 c/src/lib/libbsp/arm/lpc32xx/console/hsu.c            | 2 +-
 c/src/lib/libbsp/arm/lpc32xx/include/boot.h           | 2 +-
 c/src/lib/libbsp/arm/lpc32xx/include/bsp.h            | 8 ++++----
 c/src/lib/libbsp/arm/lpc32xx/include/i2c.h            | 2 +-
 c/src/lib/libbsp/arm/lpc32xx/include/irq.h            | 8 ++++++--
 c/src/lib/libbsp/arm/lpc32xx/include/lpc32xx.h        | 2 +-
 c/src/lib/libbsp/arm/lpc32xx/include/mmu.h            | 2 +-
 c/src/lib/libbsp/arm/lpc32xx/include/nand-mlc.h       | 2 +-
 c/src/lib/libbsp/arm/lpc32xx/include/tm27.h           | 7 +++++++
 c/src/lib/libbsp/arm/lpc32xx/irq/irq.c                | 2 +-
 c/src/lib/libbsp/arm/lpc32xx/misc/idle-thread.c       | 2 +-
 c/src/lib/libbsp/arm/lpc32xx/misc/nand-select.c       | 2 +-
 c/src/lib/libbsp/arm/lpc32xx/misc/restart.c           | 2 +-
 c/src/lib/libbsp/arm/lpc32xx/misc/system-clocks.c     | 2 +-
 c/src/lib/libbsp/arm/lpc32xx/misc/timer.c             | 2 +-
 c/src/lib/libbsp/arm/lpc32xx/rtc/rtc-config.c         | 2 +-
 c/src/lib/libbsp/arm/lpc32xx/startup/bspreset.c       | 2 +-
 c/src/lib/libbsp/arm/lpc32xx/startup/bspstart.c       | 2 +-
 c/src/lib/libbsp/arm/lpc32xx/startup/bspstarthooks.c  | 2 +-
 c/src/lib/libbsp/arm/shared/include/arm-cp15-start.h  | 9 +++++++++
 c/src/lib/libbsp/arm/shared/lpc/include/lpc-dma.h     | 4 ++--
 c/src/lib/libbsp/arm/shared/lpc/include/lpc-emc.h     | 4 ++--
 c/src/lib/libbsp/arm/shared/lpc/include/lpc-i2s.h     | 4 ++--
 c/src/lib/libbsp/arm/shared/lpc/include/lpc-lcd.h     | 2 +-
 c/src/lib/libbsp/arm/shared/lpc/include/lpc-timer.h   | 4 ++--
 c/src/lib/libbsp/shared/include/irq-generic.h         | 2 ++
 c/src/lib/libbsp/shared/include/irq-info.h            | 8 --------
 c/src/lib/libbsp/shared/include/irq.h                 | 8 --------
 29 files changed, 54 insertions(+), 48 deletions(-)

diff --git a/c/src/lib/libbsp/arm/lpc32xx/console/console-config.c b/c/src/lib/libbsp/arm/lpc32xx/console/console-config.c
index 7caaca5581..d6c5f1a81e 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/console/console-config.c
+++ b/c/src/lib/libbsp/arm/lpc32xx/console/console-config.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief Console configuration.
  */
diff --git a/c/src/lib/libbsp/arm/lpc32xx/console/hsu.c b/c/src/lib/libbsp/arm/lpc32xx/console/hsu.c
index 3065a12fc2..ec0c12c707 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/console/hsu.c
+++ b/c/src/lib/libbsp/arm/lpc32xx/console/hsu.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief High speed UART driver (14-clock).
  */
diff --git a/c/src/lib/libbsp/arm/lpc32xx/include/boot.h b/c/src/lib/libbsp/arm/lpc32xx/include/boot.h
index 1f841761a7..b7fd1a04fd 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/include/boot.h
+++ b/c/src/lib/libbsp/arm/lpc32xx/include/boot.h
@@ -33,7 +33,7 @@ extern "C" {
 /**
  * @defgroup lpc32xx_boot Boot Support
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief Boot support.
  *
diff --git a/c/src/lib/libbsp/arm/lpc32xx/include/bsp.h b/c/src/lib/libbsp/arm/lpc32xx/include/bsp.h
index 5e6800f722..751e6825d8 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/include/bsp.h
+++ b/c/src/lib/libbsp/arm/lpc32xx/include/bsp.h
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief Global BSP definitions.
  */
@@ -43,9 +43,9 @@ extern "C" {
 struct rtems_bsdnet_ifconfig;
 
 /**
- * @defgroup lpc32xx LPC32XX Support
+ * @defgroup arm_lpc32xx LPC32XX Support
  *
- * @ingroup bsp_kit
+ * @ingroup bsp_arm
  *
  * @brief LPC32XX support package.
  *
@@ -247,7 +247,7 @@ extern uint32_t lpc32xx_magic_zero_size [];
 /**
  * @defgroup lpc LPC Support
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief LPC support package.
  */
diff --git a/c/src/lib/libbsp/arm/lpc32xx/include/i2c.h b/c/src/lib/libbsp/arm/lpc32xx/include/i2c.h
index 232f834d34..22c67fdef2 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/include/i2c.h
+++ b/c/src/lib/libbsp/arm/lpc32xx/include/i2c.h
@@ -33,7 +33,7 @@ extern "C" {
 /**
  * @defgroup lpc32xx_i2c I2C Support
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief I2C Support
  *
diff --git a/c/src/lib/libbsp/arm/lpc32xx/include/irq.h b/c/src/lib/libbsp/arm/lpc32xx/include/irq.h
index 5025fd79be..46d6c5995e 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/include/irq.h
+++ b/c/src/lib/libbsp/arm/lpc32xx/include/irq.h
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup bsp_interrupt
+ * @ingroup lpc32xx_interrupt
  *
  * @brief Interrupt definitions.
  */
@@ -33,7 +33,11 @@ extern "C" {
 #endif /* __cplusplus */
 
 /**
- * @addtogroup bsp_interrupt
+ * @defgroup lpc32xx_interrupt Interrupt Support
+ *
+ * @ingroup arm_lpc32xx
+ *
+ * @ingroup bsp_interrupt
  *
  * @{
  */
diff --git a/c/src/lib/libbsp/arm/lpc32xx/include/lpc32xx.h b/c/src/lib/libbsp/arm/lpc32xx/include/lpc32xx.h
index 8c5c5f3999..2edb1e334e 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/include/lpc32xx.h
+++ b/c/src/lib/libbsp/arm/lpc32xx/include/lpc32xx.h
@@ -33,7 +33,7 @@
 /**
  * @defgroup lpc32xx_reg Register Definitions
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief Register definitions.
  *
diff --git a/c/src/lib/libbsp/arm/lpc32xx/include/mmu.h b/c/src/lib/libbsp/arm/lpc32xx/include/mmu.h
index 8ed5cc7ada..dd00727928 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/include/mmu.h
+++ b/c/src/lib/libbsp/arm/lpc32xx/include/mmu.h
@@ -32,7 +32,7 @@ extern "C" {
 /**
  * @defgroup lpc32xx_mmu MMU Support
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief MMU support.
  *
diff --git a/c/src/lib/libbsp/arm/lpc32xx/include/nand-mlc.h b/c/src/lib/libbsp/arm/lpc32xx/include/nand-mlc.h
index 5fed9031b6..2bdc222561 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/include/nand-mlc.h
+++ b/c/src/lib/libbsp/arm/lpc32xx/include/nand-mlc.h
@@ -36,7 +36,7 @@ extern "C" {
 /**
  * @defgroup lpc32xx_nand_mlc NAND MLC Controller
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief NAND MLC Controller.
  *
diff --git a/c/src/lib/libbsp/arm/lpc32xx/include/tm27.h b/c/src/lib/libbsp/arm/lpc32xx/include/tm27.h
index 7c6ae6c1e6..412ad30158 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/include/tm27.h
+++ b/c/src/lib/libbsp/arm/lpc32xx/include/tm27.h
@@ -1,3 +1,10 @@
+/* @file 
+ *
+ * @ingroup arm_lpc32xx
+ *
+ * @brief Implementations of interrupt mechanisms for Time Test 27
+ */
+
 /*
  * Copyright (c) 2010 embedded brains GmbH.  All rights reserved.
  *
diff --git a/c/src/lib/libbsp/arm/lpc32xx/irq/irq.c b/c/src/lib/libbsp/arm/lpc32xx/irq/irq.c
index 67506ee9f9..0ea307fba7 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/irq/irq.c
+++ b/c/src/lib/libbsp/arm/lpc32xx/irq/irq.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup bsp_interrupt
+ * @ingroup lpc32xx_interrupt
  *
  * @brief Interrupt support.
  */
diff --git a/c/src/lib/libbsp/arm/lpc32xx/misc/idle-thread.c b/c/src/lib/libbsp/arm/lpc32xx/misc/idle-thread.c
index 0ac51c0f46..6addfc6d7d 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/misc/idle-thread.c
+++ b/c/src/lib/libbsp/arm/lpc32xx/misc/idle-thread.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief bsp_idle_thread() implementation.
  */
diff --git a/c/src/lib/libbsp/arm/lpc32xx/misc/nand-select.c b/c/src/lib/libbsp/arm/lpc32xx/misc/nand-select.c
index 533680ee92..13cc4d1d4a 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/misc/nand-select.c
+++ b/c/src/lib/libbsp/arm/lpc32xx/misc/nand-select.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief NAND controller selection.
  */
diff --git a/c/src/lib/libbsp/arm/lpc32xx/misc/restart.c b/c/src/lib/libbsp/arm/lpc32xx/misc/restart.c
index e81966ea41..6f705f963b 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/misc/restart.c
+++ b/c/src/lib/libbsp/arm/lpc32xx/misc/restart.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief Restart implementation.
  */
diff --git a/c/src/lib/libbsp/arm/lpc32xx/misc/system-clocks.c b/c/src/lib/libbsp/arm/lpc32xx/misc/system-clocks.c
index c816912849..2efbe258a4 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/misc/system-clocks.c
+++ b/c/src/lib/libbsp/arm/lpc32xx/misc/system-clocks.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief System clocks.
  */
diff --git a/c/src/lib/libbsp/arm/lpc32xx/misc/timer.c b/c/src/lib/libbsp/arm/lpc32xx/misc/timer.c
index d70ab4faf8..fca60e7ae2 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/misc/timer.c
+++ b/c/src/lib/libbsp/arm/lpc32xx/misc/timer.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief Benchmark timer support.
  */
diff --git a/c/src/lib/libbsp/arm/lpc32xx/rtc/rtc-config.c b/c/src/lib/libbsp/arm/lpc32xx/rtc/rtc-config.c
index bcbc20fce9..d6a548394c 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/rtc/rtc-config.c
+++ b/c/src/lib/libbsp/arm/lpc32xx/rtc/rtc-config.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief RTC configuration.
  */
diff --git a/c/src/lib/libbsp/arm/lpc32xx/startup/bspreset.c b/c/src/lib/libbsp/arm/lpc32xx/startup/bspreset.c
index af42d5e4d0..0115c25507 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/startup/bspreset.c
+++ b/c/src/lib/libbsp/arm/lpc32xx/startup/bspreset.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief Reset code.
  */
diff --git a/c/src/lib/libbsp/arm/lpc32xx/startup/bspstart.c b/c/src/lib/libbsp/arm/lpc32xx/startup/bspstart.c
index 67ab94a9cb..2a8bcc76e1 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/startup/bspstart.c
+++ b/c/src/lib/libbsp/arm/lpc32xx/startup/bspstart.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief Startup code.
  */
diff --git a/c/src/lib/libbsp/arm/lpc32xx/startup/bspstarthooks.c b/c/src/lib/libbsp/arm/lpc32xx/startup/bspstarthooks.c
index 3523792794..c20e9ac8b4 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/startup/bspstarthooks.c
+++ b/c/src/lib/libbsp/arm/lpc32xx/startup/bspstarthooks.c
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief Startup code.
  */
diff --git a/c/src/lib/libbsp/arm/shared/include/arm-cp15-start.h b/c/src/lib/libbsp/arm/shared/include/arm-cp15-start.h
index 1ff5222718..54f29636a2 100644
--- a/c/src/lib/libbsp/arm/shared/include/arm-cp15-start.h
+++ b/c/src/lib/libbsp/arm/shared/include/arm-cp15-start.h
@@ -1,3 +1,12 @@
+/**
+ * @file 
+ *
+ * @ingroup arm_start
+ *
+ * @brief Arm CP15 start.
+ */
+
+
 /*
  * Copyright (c) 2013 Hesham AL-Matary.
  * Copyright (c) 2009-2013 embedded brains GmbH.  All rights reserved.
diff --git a/c/src/lib/libbsp/arm/shared/lpc/include/lpc-dma.h b/c/src/lib/libbsp/arm/shared/lpc/include/lpc-dma.h
index 7ac9e19fa8..b343b3708b 100644
--- a/c/src/lib/libbsp/arm/shared/lpc/include/lpc-dma.h
+++ b/c/src/lib/libbsp/arm/shared/lpc/include/lpc-dma.h
@@ -33,8 +33,8 @@ extern "C" {
 /**
  * @defgroup lpc_dma DMA Support
  *
- * @ingroup lpc24xx
- * @ingroup lpc32xx
+ * @ingroup arm_lpc24xx
+ * @ingroup arm_lpc32xx
  *
  * @brief DMA support.
  *
diff --git a/c/src/lib/libbsp/arm/shared/lpc/include/lpc-emc.h b/c/src/lib/libbsp/arm/shared/lpc/include/lpc-emc.h
index c95a791144..c0ba676375 100644
--- a/c/src/lib/libbsp/arm/shared/lpc/include/lpc-emc.h
+++ b/c/src/lib/libbsp/arm/shared/lpc/include/lpc-emc.h
@@ -32,8 +32,8 @@ extern "C" {
 /**
  * @defgroup lpc_emc EMC Support
  *
- * @ingroup lpc24xx
- * @ingroup lpc32xx
+ * @ingroup arm_lpc24xx
+ * @ingroup arm_lpc32xx
  *
  * @brief EMC Support
  *
diff --git a/c/src/lib/libbsp/arm/shared/lpc/include/lpc-i2s.h b/c/src/lib/libbsp/arm/shared/lpc/include/lpc-i2s.h
index 1be0a8a8e0..fbbba5cbed 100644
--- a/c/src/lib/libbsp/arm/shared/lpc/include/lpc-i2s.h
+++ b/c/src/lib/libbsp/arm/shared/lpc/include/lpc-i2s.h
@@ -32,8 +32,8 @@ extern "C" {
 /**
  * @defgroup lpc_i2s I2S Support
  *
- * @ingroup lpc24xx
- * @ingroup lpc32xx
+ * @ingroup arm_lpc24xx
+ * @ingroup arm_lpc32xx
  *
  * @brief I2S support.
  *
diff --git a/c/src/lib/libbsp/arm/shared/lpc/include/lpc-lcd.h b/c/src/lib/libbsp/arm/shared/lpc/include/lpc-lcd.h
index 0a311d91a3..c9976858ba 100644
--- a/c/src/lib/libbsp/arm/shared/lpc/include/lpc-lcd.h
+++ b/c/src/lib/libbsp/arm/shared/lpc/include/lpc-lcd.h
@@ -33,7 +33,7 @@ extern "C" {
  * @defgroup lpc_lcd LCD Support
  *
  * @ingroup lpc
- * @ingroup lpc32xx
+ * @ingroup arm_lpc32xx
  *
  * @brief LCD support.
  *
diff --git a/c/src/lib/libbsp/arm/shared/lpc/include/lpc-timer.h b/c/src/lib/libbsp/arm/shared/lpc/include/lpc-timer.h
index b30965b093..ee6e35e907 100644
--- a/c/src/lib/libbsp/arm/shared/lpc/include/lpc-timer.h
+++ b/c/src/lib/libbsp/arm/shared/lpc/include/lpc-timer.h
@@ -31,8 +31,8 @@ extern "C" {
 /**
  * @defgroup lpc_timer Timer Support
  *
- * @ingroup lpc24xx
- * @ingroup lpc32xx
+ * @ingroup arm_lpc24xx
+ * @ingroup arm_lpc32xx
  *
  * @brief Timer support.
  *
diff --git a/c/src/lib/libbsp/shared/include/irq-generic.h b/c/src/lib/libbsp/shared/include/irq-generic.h
index d365c0c851..a703c69e9d 100644
--- a/c/src/lib/libbsp/shared/include/irq-generic.h
+++ b/c/src/lib/libbsp/shared/include/irq-generic.h
@@ -91,6 +91,8 @@ static inline rtems_vector_number bsp_interrupt_handler_index(
  * @defgroup bsp_interrupt BSP Interrupt Support
  *
  * @ingroup rtems_interrupt_extension
+ * 
+ * @brief Generic BSP Interrupt Support
  *
  * The BSP interrupt support manages a sequence of interrupt vector numbers
  * ranging from @ref BSP_INTERRUPT_VECTOR_MIN to @ref BSP_INTERRUPT_VECTOR_MAX
diff --git a/c/src/lib/libbsp/shared/include/irq-info.h b/c/src/lib/libbsp/shared/include/irq-info.h
index 02efc955c0..accb214c00 100644
--- a/c/src/lib/libbsp/shared/include/irq-info.h
+++ b/c/src/lib/libbsp/shared/include/irq-info.h
@@ -29,14 +29,6 @@
 extern "C" {
 #endif /* __cplusplus */
 
-/**
- * @defgroup bsp_interrupt BSP Interrupt Information
- *
- * @ingroup rtems_interrupt_extension
- *
- * @{
- */
-
 /**
  * @brief Prints interrupt information via the printk plugin @a print with the
  * context @a context.
diff --git a/c/src/lib/libbsp/shared/include/irq.h b/c/src/lib/libbsp/shared/include/irq.h
index 19aed6fd40..5d33b71910 100644
--- a/c/src/lib/libbsp/shared/include/irq.h
+++ b/c/src/lib/libbsp/shared/include/irq.h
@@ -26,12 +26,6 @@
 
 #include <stdint.h>
 
-/**
- * @addtogroup bsp_interrupt
- *
- * @{
- */
-
 /**
  * @brief Minimum vector number.
  */
@@ -80,6 +74,4 @@
  */
 #undef BSP_INTERRUPT_CUSTOM_VALID_VECTOR
 
-/** @} */
-
 #endif /* LIBBSP_SHARED_IRQ_CONFIG_H */
-- 
cgit v1.2.3