[rtems commit] arm/gba: doxygen improvement
Gedare Bloom
gedare at rtems.org
Fri Dec 20 00:52:04 UTC 2013
Module: rtems
Branch: master
Commit: 7b10f130e641f662bae77e7c162fa96b57f1d960
Changeset: http://git.rtems.org/rtems/commit/?id=7b10f130e641f662bae77e7c162fa96b57f1d960
Author: Toma <radustoma at yahoo.com>
Date: Thu Dec 19 15:51:42 2013 -0600
arm/gba: doxygen improvement
Add doxygen to the header files in the arm/gba include,
irq, and console directories.
---
c/src/lib/libbsp/arm/gba/console/defaultfont.h | 7 +++++--
c/src/lib/libbsp/arm/gba/include/arm_mode_bits.h | 7 ++++---
c/src/lib/libbsp/arm/gba/include/asm_macros.h | 7 +++++--
c/src/lib/libbsp/arm/gba/include/bsp.h | 14 ++++++++++++--
c/src/lib/libbsp/arm/gba/include/conio.h | 15 +++++++++++++--
c/src/lib/libbsp/arm/gba/include/gba.h | 7 +++++--
c/src/lib/libbsp/arm/gba/include/gba_registers.h | 15 ++++++++++++---
c/src/lib/libbsp/arm/gba/irq/irq.h | 16 +++++++++++++---
8 files changed, 69 insertions(+), 19 deletions(-)
diff --git a/c/src/lib/libbsp/arm/gba/console/defaultfont.h b/c/src/lib/libbsp/arm/gba/console/defaultfont.h
index da1c504..a3bd5ec 100644
--- a/c/src/lib/libbsp/arm/gba/console/defaultfont.h
+++ b/c/src/lib/libbsp/arm/gba/console/defaultfont.h
@@ -1,8 +1,11 @@
/**
- * @file defaultfont.c
+ * @file
*
- * This file contains default font definitions.
+ * @ingroup arm_gba
+ *
+ * @brief Default font definitions.
*/
+
/*
* RTEMS GBA BSP
*
diff --git a/c/src/lib/libbsp/arm/gba/include/arm_mode_bits.h b/c/src/lib/libbsp/arm/gba/include/arm_mode_bits.h
index 844d649..b8368fb 100644
--- a/c/src/lib/libbsp/arm/gba/include/arm_mode_bits.h
+++ b/c/src/lib/libbsp/arm/gba/include/arm_mode_bits.h
@@ -1,10 +1,11 @@
/**
- * @file arm_mode_bits.h
+ * @file
*
- * ARM statusregister mode bits.
+ * @ingroup arm_gba
*
- * This include file contains definitions related to the ARM BSP.
+ * @brief ARM status register mode bits.
*/
+
/*
* RTEMS GBA BSP
*
diff --git a/c/src/lib/libbsp/arm/gba/include/asm_macros.h b/c/src/lib/libbsp/arm/gba/include/asm_macros.h
index f994f22..9080109 100644
--- a/c/src/lib/libbsp/arm/gba/include/asm_macros.h
+++ b/c/src/lib/libbsp/arm/gba/include/asm_macros.h
@@ -1,8 +1,11 @@
/**
- * @file asm_macros.h
+ * @file
*
- * This include file contains definitions related to the GBA BSP.
+ * @ingroup arm_gba
+ *
+ * @brief ASM macros.
*/
+
/*
* RTEMS GBA BSP
*
diff --git a/c/src/lib/libbsp/arm/gba/include/bsp.h b/c/src/lib/libbsp/arm/gba/include/bsp.h
index 0bc3093..f5c108d 100644
--- a/c/src/lib/libbsp/arm/gba/include/bsp.h
+++ b/c/src/lib/libbsp/arm/gba/include/bsp.h
@@ -1,8 +1,11 @@
/**
- * @file bsp.h
+ * @file
*
- * This include file contains definitions related to the GBA BSP.
+ * @ingroup arm_gba
+ *
+ * @brief Global BSP definitions.
*/
+
/*
* RTEMS GBA BSP
*
@@ -60,4 +63,11 @@ extern void gba_set_memory(int start, int stop, int data);
#endif /* __BSP_H_ */
+/**
+ * @defgroup arm_gba GBA Support
+ *
+ * @ingroup bsp_arm
+ *
+ * @brief GBA support package.
+ */
diff --git a/c/src/lib/libbsp/arm/gba/include/conio.h b/c/src/lib/libbsp/arm/gba/include/conio.h
index e47be1f..e0f3f40 100644
--- a/c/src/lib/libbsp/arm/gba/include/conio.h
+++ b/c/src/lib/libbsp/arm/gba/include/conio.h
@@ -1,8 +1,11 @@
/**
- * @file conio.h
+ * @file
*
- * This file contains the GBA conio I/O package.
+ * @ingroup gba_conio
+ *
+ * @brief GBA conio I/O package.
*/
+
/*
* RTEMS GBA BSP
*
@@ -20,6 +23,14 @@
extern "C" {
#endif
+/**
+ * @defgroup gba_conio GBA Conio I/O
+ *
+ * @ingroup arm_gba
+ *
+ * @brief GBA Conio I/O support.
+ */
+
/*---------------------------------------------------------------------------*
* Includes *
*---------------------------------------------------------------------------*/
diff --git a/c/src/lib/libbsp/arm/gba/include/gba.h b/c/src/lib/libbsp/arm/gba/include/gba.h
index 4c53c62..8e5675e 100644
--- a/c/src/lib/libbsp/arm/gba/include/gba.h
+++ b/c/src/lib/libbsp/arm/gba/include/gba.h
@@ -1,8 +1,11 @@
/**
- * @file gba.h
+ * @file
*
- * This include file contains definitions related to the ARM BSP.
+ * @ingroup arm_gba
+ *
+ * @brief GameBoy Advance definitions.
*/
+
/*
* RTEMS GBA BSP
*
diff --git a/c/src/lib/libbsp/arm/gba/include/gba_registers.h b/c/src/lib/libbsp/arm/gba/include/gba_registers.h
index 0a85877..3397e69 100644
--- a/c/src/lib/libbsp/arm/gba/include/gba_registers.h
+++ b/c/src/lib/libbsp/arm/gba/include/gba_registers.h
@@ -1,10 +1,11 @@
/**
- * @file gba_registers.h
+ * @file
*
- * Game Boy Advance registers.
+ * @ingroup gba_reg
*
- * This include file contains definitions related to the ARM BSP.
+ * @brief Register definitions.
*/
+
/*
* RTEMS GBA BSP
*
@@ -38,6 +39,14 @@
extern volatile unsigned int *Regs; /**< Chip registers */
#endif
+/**
+ * @defgroup gba_reg Register Definitions
+ *
+ * @ingroup arm_gba
+ *
+ * @brief Register definitions.
+ */
+
/*---------------------------------------------------------------------------+
| General address definitions
diff --git a/c/src/lib/libbsp/arm/gba/irq/irq.h b/c/src/lib/libbsp/arm/gba/irq/irq.h
index d0c841f..62d3f00 100644
--- a/c/src/lib/libbsp/arm/gba/irq/irq.h
+++ b/c/src/lib/libbsp/arm/gba/irq/irq.h
@@ -1,9 +1,11 @@
/**
- * @file irq.h
+ * @file
*
- * This include file describe the data structure and the functions implemented
- * by rtems to write interrupt handlers.
+ * @ingroup gba_interrupt
+ *
+ * @brief Interrupt definitions.
*/
+
/*
* RTEMS GBA BSP
*
@@ -27,6 +29,14 @@
#ifndef _IRQ_H_
#define _IRQ_H_
+/**
+ * @defgroup gba_interrupt Interrupt Support
+ *
+ * @ingroup arm_gba
+ *
+ * @brief Interrupt support.
+ */
+
/*---------------------------------------------------------------------------*
* MACROS *
*---------------------------------------------------------------------------*/
More information about the vc
mailing list