arm/gba: doxygen improvement

Add doxygen to the header files in the arm/gba include,
irq, and console directories.
This commit is contained in:
Toma
2013-12-19 15:51:42 -06:00
committed by Gedare Bloom
parent fe011a59a4
commit 7b10f130e6
8 changed files with 69 additions and 19 deletions

View File

@@ -1,8 +1,11 @@
/**
* @file defaultfont.c
* @file
*
* This file contains default font definitions.
* @ingroup arm_gba
*
* @brief Default font definitions.
*/
/*
* RTEMS GBA BSP
*

View File

@@ -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
*

View File

@@ -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
*

View File

@@ -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.
*/

View File

@@ -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 *
*---------------------------------------------------------------------------*/

View File

@@ -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
*

View File

@@ -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

View File

@@ -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 *
*---------------------------------------------------------------------------*/