From 7b10f130e641f662bae77e7c162fa96b57f1d960 Mon Sep 17 00:00:00 2001
From: Toma <radustoma@yahoo.com>
Date: Thu, 19 Dec 2013 15:51:42 -0600
Subject: 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(-)

(limited to 'c/src/lib')

diff --git a/c/src/lib/libbsp/arm/gba/console/defaultfont.h b/c/src/lib/libbsp/arm/gba/console/defaultfont.h
index da1c504af8..a3bd5ec933 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 844d649d60..b8368fb935 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 f994f225c4..9080109c8e 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 0bc3093b8a..f5c108dbed 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 e47be1f8e1..e0f3f4058e 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 4c53c62c1a..8e5675e538 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 0a85877240..3397e6904a 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 d0c841faf9..62d3f008bd 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                                                                   *
  *---------------------------------------------------------------------------*/
-- 
cgit v1.2.3