RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

doxygen: refactored doxygen in libbsp/arm/lpc32xx

Browse Source 
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.
This commit is contained in:
Daniel Ramirez
2013-11-29 20:18:44 -06:00
committed by Gedare Bloom
parent ad36dc2c36
commit 2d6543d4c8
29 changed files with 54 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
c/src/lib/libbsp/arm/lpc32xx/console/console-config.c
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief Console configuration. * @brief Console configuration.
*/ */

2
c/src/lib/libbsp/arm/lpc32xx/console/hsu.c
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief High speed UART driver (14-clock). * @brief High speed UART driver (14-clock).
*/ */

2
c/src/lib/libbsp/arm/lpc32xx/include/boot.h
View File

@@ -33,7 +33,7 @@ extern "C" {
/** /**
* @defgroup lpc32xx_boot Boot Support * @defgroup lpc32xx_boot Boot Support
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief Boot support. * @brief Boot support.
* *

8
c/src/lib/libbsp/arm/lpc32xx/include/bsp.h
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief Global BSP definitions. * @brief Global BSP definitions.
*/ */
@@ -43,9 +43,9 @@ extern "C" {
struct rtems_bsdnet_ifconfig; struct rtems_bsdnet_ifconfig;
/** /**
* @defgroup lpc32xx LPC32XX Support * @defgroup arm_lpc32xx LPC32XX Support
* *
* @ingroup bsp_kit * @ingroup bsp_arm
* *
* @brief LPC32XX support package. * @brief LPC32XX support package.
* *
@@ -247,7 +247,7 @@ extern uint32_t lpc32xx_magic_zero_size [];
/** /**
* @defgroup lpc LPC Support * @defgroup lpc LPC Support
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief LPC support package. * @brief LPC support package.
*/ */

2
c/src/lib/libbsp/arm/lpc32xx/include/i2c.h
View File

@@ -33,7 +33,7 @@ extern "C" {
/** /**
* @defgroup lpc32xx_i2c I2C Support * @defgroup lpc32xx_i2c I2C Support
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief I2C Support * @brief I2C Support
* *

8
c/src/lib/libbsp/arm/lpc32xx/include/irq.h
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup bsp_interrupt * @ingroup lpc32xx_interrupt
* *
* @brief Interrupt definitions. * @brief Interrupt definitions.
*/ */
@@ -33,7 +33,11 @@ extern "C" {
#endif /* __cplusplus */ #endif /* __cplusplus */
/** /**
* @addtogroup bsp_interrupt * @defgroup lpc32xx_interrupt Interrupt Support
*
* @ingroup arm_lpc32xx
*
* @ingroup bsp_interrupt
* *
* @{ * @{
*/ */

2
c/src/lib/libbsp/arm/lpc32xx/include/lpc32xx.h
View File

@@ -33,7 +33,7 @@
/** /**
* @defgroup lpc32xx_reg Register Definitions * @defgroup lpc32xx_reg Register Definitions
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief Register definitions. * @brief Register definitions.
* *

2
c/src/lib/libbsp/arm/lpc32xx/include/mmu.h
View File

@@ -32,7 +32,7 @@ extern "C" {
/** /**
* @defgroup lpc32xx_mmu MMU Support * @defgroup lpc32xx_mmu MMU Support
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief MMU support. * @brief MMU support.
* *

2
c/src/lib/libbsp/arm/lpc32xx/include/nand-mlc.h
View File

@@ -36,7 +36,7 @@ extern "C" {
/** /**
* @defgroup lpc32xx_nand_mlc NAND MLC Controller * @defgroup lpc32xx_nand_mlc NAND MLC Controller
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief NAND MLC Controller. * @brief NAND MLC Controller.
* *

7
c/src/lib/libbsp/arm/lpc32xx/include/tm27.h
View File

@@ -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. * Copyright (c) 2010 embedded brains GmbH. All rights reserved.
* *

2
c/src/lib/libbsp/arm/lpc32xx/irq/irq.c
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup bsp_interrupt * @ingroup lpc32xx_interrupt
* *
* @brief Interrupt support. * @brief Interrupt support.
*/ */

2
c/src/lib/libbsp/arm/lpc32xx/misc/idle-thread.c
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief bsp_idle_thread() implementation. * @brief bsp_idle_thread() implementation.
*/ */

2
c/src/lib/libbsp/arm/lpc32xx/misc/nand-select.c
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief NAND controller selection. * @brief NAND controller selection.
*/ */

2
c/src/lib/libbsp/arm/lpc32xx/misc/restart.c
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief Restart implementation. * @brief Restart implementation.
*/ */

2
c/src/lib/libbsp/arm/lpc32xx/misc/system-clocks.c
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief System clocks. * @brief System clocks.
*/ */

2
c/src/lib/libbsp/arm/lpc32xx/misc/timer.c
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief Benchmark timer support. * @brief Benchmark timer support.
*/ */

2
c/src/lib/libbsp/arm/lpc32xx/rtc/rtc-config.c
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief RTC configuration. * @brief RTC configuration.
*/ */

2
c/src/lib/libbsp/arm/lpc32xx/startup/bspreset.c
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief Reset code. * @brief Reset code.
*/ */

2
c/src/lib/libbsp/arm/lpc32xx/startup/bspstart.c
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief Startup code. * @brief Startup code.
*/ */

2
c/src/lib/libbsp/arm/lpc32xx/startup/bspstarthooks.c
View File

@@ -1,7 +1,7 @@
/** /**
* @file * @file
* *
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief Startup code. * @brief Startup code.
*/ */

9
c/src/lib/libbsp/arm/shared/include/arm-cp15-start.h
View File

@@ -1,3 +1,12 @@
/**
* @file
*
* @ingroup arm_start
*
* @brief Arm CP15 start.
*/
/* /*
* Copyright (c) 2013 Hesham AL-Matary. * Copyright (c) 2013 Hesham AL-Matary.
* Copyright (c) 2009-2013 embedded brains GmbH. All rights reserved. * Copyright (c) 2009-2013 embedded brains GmbH. All rights reserved.

4
c/src/lib/libbsp/arm/shared/lpc/include/lpc-dma.h
View File

@@ -33,8 +33,8 @@ extern "C" {
/** /**
* @defgroup lpc_dma DMA Support * @defgroup lpc_dma DMA Support
* *
* @ingroup lpc24xx * @ingroup arm_lpc24xx
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief DMA support. * @brief DMA support.
* *

4
c/src/lib/libbsp/arm/shared/lpc/include/lpc-emc.h
View File

@@ -32,8 +32,8 @@ extern "C" {
/** /**
* @defgroup lpc_emc EMC Support * @defgroup lpc_emc EMC Support
* *
* @ingroup lpc24xx * @ingroup arm_lpc24xx
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief EMC Support * @brief EMC Support
* *

4
c/src/lib/libbsp/arm/shared/lpc/include/lpc-i2s.h
View File

@@ -32,8 +32,8 @@ extern "C" {
/** /**
* @defgroup lpc_i2s I2S Support * @defgroup lpc_i2s I2S Support
* *
* @ingroup lpc24xx * @ingroup arm_lpc24xx
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief I2S support. * @brief I2S support.
* *

2
c/src/lib/libbsp/arm/shared/lpc/include/lpc-lcd.h
View File

@@ -33,7 +33,7 @@ extern "C" {
* @defgroup lpc_lcd LCD Support * @defgroup lpc_lcd LCD Support
* *
* @ingroup lpc * @ingroup lpc
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief LCD support. * @brief LCD support.
* *

4
c/src/lib/libbsp/arm/shared/lpc/include/lpc-timer.h
View File

@@ -31,8 +31,8 @@ extern "C" {
/** /**
* @defgroup lpc_timer Timer Support * @defgroup lpc_timer Timer Support
* *
* @ingroup lpc24xx * @ingroup arm_lpc24xx
* @ingroup lpc32xx * @ingroup arm_lpc32xx
* *
* @brief Timer support. * @brief Timer support.
* *

2
c/src/lib/libbsp/shared/include/irq-generic.h
View File

@@ -92,6 +92,8 @@ static inline rtems_vector_number bsp_interrupt_handler_index(
* *
* @ingroup rtems_interrupt_extension * @ingroup rtems_interrupt_extension
* *
* @brief Generic BSP Interrupt Support
*
* The BSP interrupt support manages a sequence of interrupt vector numbers * The BSP interrupt support manages a sequence of interrupt vector numbers
* ranging from @ref BSP_INTERRUPT_VECTOR_MIN to @ref BSP_INTERRUPT_VECTOR_MAX * ranging from @ref BSP_INTERRUPT_VECTOR_MIN to @ref BSP_INTERRUPT_VECTOR_MAX
* including the end points. It provides methods to * including the end points. It provides methods to

8
c/src/lib/libbsp/shared/include/irq-info.h
View File

@@ -29,14 +29,6 @@
extern "C" { extern "C" {
#endif /* __cplusplus */ #endif /* __cplusplus */
/**
* @defgroup bsp_interrupt BSP Interrupt Information
*
* @ingroup rtems_interrupt_extension
*
* @{
*/
/** /**
* @brief Prints interrupt information via the printk plugin @a print with the * @brief Prints interrupt information via the printk plugin @a print with the
* context @a context. * context @a context.

8
c/src/lib/libbsp/shared/include/irq.h
View File

@@ -26,12 +26,6 @@
#include <stdint.h> #include <stdint.h>
/**
* @addtogroup bsp_interrupt
*
* @{
*/
/** /**
* @brief Minimum vector number. * @brief Minimum vector number.
*/ */
@@ -80,6 +74,4 @@
*/ */
#undef BSP_INTERRUPT_CUSTOM_VALID_VECTOR #undef BSP_INTERRUPT_CUSTOM_VALID_VECTOR
/** @} */
#endif /* LIBBSP_SHARED_IRQ_CONFIG_H */ #endif /* LIBBSP_SHARED_IRQ_CONFIG_H */