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.
2013-11-29 20:18:44 -06:00
parent ad36dc2c36
commit 2d6543d4c8
29 changed files with 54 additions and 48 deletions
--- 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.
 */
--- 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).
 */
--- 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.
 *
--- 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.
 */
--- 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
 *
--- 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
 *
 * @{
 */
--- 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.
 *
--- 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.
 *
--- 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.
 *
--- 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.
 *
--- 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.
 */
--- 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.
 */
--- 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.
 */
--- 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.
 */
--- 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.
 */
--- 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.
 */
--- 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.
 */
--- 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.
 */
--- 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.
 */
--- 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.
 */
--- 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.
--- 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.
 *
--- 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
 *
--- 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.
 *
--- 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.
 *
--- 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.
 *
--- a/c/src/lib/libbsp/shared/include/irq-generic.h
+++ b/c/src/lib/libbsp/shared/include/irq-generic.h
@@ -92,6 +92,8 @@ static inline rtems_vector_number bsp_interrupt_handler_index(
 *
 * @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
 * including the end points.  It provides methods to
--- 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.
--- 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 */