diff options
author | Daniel Ramirez <javamonn@gmail.com> | 2013-11-29 20:18:44 -0600 |
---|---|---|
committer | Gedare Bloom <gedare@rtems.org> | 2013-11-29 22:48:59 -0500 |
commit | 2d6543d4c84cc896b7ff357772ea02472d49d882 (patch) | |
tree | 130c1e771b242611809f19f77510fcf45b62c413 /c/src/lib/libbsp/arm/lpc32xx | |
parent | POSIX timers: Add restrict keyword (diff) | |
download | rtems-2d6543d4c84cc896b7ff357772ea02472d49d882.tar.bz2 |
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.
Diffstat (limited to 'c/src/lib/libbsp/arm/lpc32xx')
20 files changed, 34 insertions, 23 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. */ |