Changeset 7b10f130 in rtems


Ignore:
Timestamp:
Dec 19, 2013, 9:51:42 PM (5 years ago)
Author:
Toma <radustoma@…>
Branches:
4.11, master
Children:
95a57280
Parents:
fe011a5
git-author:
Toma <radustoma@…> (12/19/13 21:51:42)
git-committer:
Gedare Bloom <gedare@…> (12/20/13 00:57:41)
Message:

arm/gba: doxygen improvement

Add doxygen to the header files in the arm/gba include,
irq, and console directories.

Location:
c/src/lib/libbsp/arm/gba
Files:
8 edited

Legend:

Unmodified
Added
Removed
  • c/src/lib/libbsp/arm/gba/console/defaultfont.h

    rfe011a5 r7b10f130  
    11/**
    2  *  @file defaultfont.c
     2 * @file
    33 *
    4  *  This file contains default font definitions.
     4 * @ingroup arm_gba
     5 *
     6 * @brief Default font definitions.
    57 */
     8
    69/*
    710 *  RTEMS GBA BSP
  • c/src/lib/libbsp/arm/gba/include/arm_mode_bits.h

    rfe011a5 r7b10f130  
    11/**
    2  * @file arm_mode_bits.h
     2 * @file
    33 *
    4  *  ARM statusregister mode bits.
     4 * @ingroup arm_gba
    55 *
    6  *  This include file contains definitions related to the ARM BSP.
     6 * @brief ARM status register mode bits.
    77 */
     8
    89/*
    910 *  RTEMS GBA BSP
  • c/src/lib/libbsp/arm/gba/include/asm_macros.h

    rfe011a5 r7b10f130  
    11/**
    2  *  @file  asm_macros.h
     2 * @file
    33 *
    4  *  This include file contains definitions related to the GBA BSP.
     4 * @ingroup arm_gba
     5 *
     6 * @brief ASM macros.
    57 */
     8
    69/*
    710 *  RTEMS GBA BSP
  • c/src/lib/libbsp/arm/gba/include/bsp.h

    rfe011a5 r7b10f130  
    11/**
    2  *  @file bsp.h
     2 * @file
    33 *
    4  *  This include file contains definitions related to the GBA BSP.
     4 * @ingroup arm_gba
     5 *
     6 * @brief Global BSP definitions.
    57 */
     8
    69/*
    710 *  RTEMS GBA BSP
     
    6164
    6265#endif /* __BSP_H_ */
     66/**
     67 * @defgroup arm_gba GBA Support
     68 *
     69 * @ingroup bsp_arm
     70 *
     71 * @brief GBA support package.
     72 */
    6373
  • c/src/lib/libbsp/arm/gba/include/conio.h

    rfe011a5 r7b10f130  
    11/**
    2  *  @file conio.h
     2 * @file
    33 *
    4  *  This file contains the GBA conio I/O package.
     4 * @ingroup gba_conio
     5 *
     6 * @brief GBA conio I/O package.
    57 */
     8
    69/*
    710 *  RTEMS GBA BSP
     
    2023extern "C" {
    2124#endif
     25
     26/**
     27 * @defgroup gba_conio GBA Conio I/O
     28 *
     29 * @ingroup arm_gba
     30 *
     31 * @brief GBA Conio I/O support.
     32 */
    2233
    2334/*---------------------------------------------------------------------------*
  • c/src/lib/libbsp/arm/gba/include/gba.h

    rfe011a5 r7b10f130  
    11/**
    2  *  @file gba.h
     2 * @file
    33 *
    4  *  This include file contains definitions related to the ARM BSP.
     4 * @ingroup arm_gba
     5 *
     6 * @brief GameBoy Advance definitions.
    57 */
     8
    69/*
    710 *  RTEMS GBA BSP
  • c/src/lib/libbsp/arm/gba/include/gba_registers.h

    rfe011a5 r7b10f130  
    11/**
    2  *  @file gba_registers.h
     2 *  @file
    33 *
    4  *  Game Boy Advance registers.
     4 *  @ingroup gba_reg
    55 *
    6  *  This include file contains definitions related to the ARM BSP.
     6 *  @brief Register definitions.
    77 */
     8
    89/*
    910 *  RTEMS GBA BSP
     
    3839extern volatile unsigned int  *Regs;        /**< Chip registers              */
    3940#endif
     41
     42/**
     43 * @defgroup gba_reg Register Definitions
     44 *
     45 * @ingroup arm_gba
     46 *
     47 * @brief Register definitions.
     48 */
    4049
    4150
  • c/src/lib/libbsp/arm/gba/irq/irq.h

    rfe011a5 r7b10f130  
    11/**
    2  *  @file irq.h
     2 * @file
    33 *
    4  *  This include file describe the data structure and the functions implemented
    5  *  by rtems to write interrupt handlers.
     4 * @ingroup gba_interrupt
     5 *
     6 * @brief Interrupt definitions.
    67 */
     8
    79/*
    810 *  RTEMS GBA BSP
     
    2729#ifndef _IRQ_H_
    2830#define _IRQ_H_
     31
     32/**
     33 * @defgroup gba_interrupt Interrupt Support
     34 *
     35 * @ingroup arm_gba
     36 *
     37 * @brief Interrupt support.
     38 */
    2939
    3040/*---------------------------------------------------------------------------*
Note: See TracChangeset for help on using the changeset viewer.