score: Doxygen Clean Up Task #16

cpukit/score/cpu/bfin/rtems/asm.h

@@ -1,17 +1,20 @@
 /**
- * @file rtems/asm.h
+ * @file
  *
- *  This include file attempts to address the problems
+ * @brief Address the Problems Caused by Incompatible Flavor of
- *  caused by incompatible flavors of assemblers and
+ * Assemblers and Toolsets
- *  toolsets.  It primarily addresses variations in the
+ *
- *  use of leading underscores on symbols and the requirement
+ * This include file attempts to address the problems
- *  that register names be preceded by a %.
+ * caused by incompatible flavors of assemblers and
+ * toolsets.  It primarily addresses variations in the
+ * use of leading underscores on symbols and the requirement
+ * that register names be preceded by a %.
+ *
+ * @note The spacing in the use of these macros
+ *       is critical to them working as advertised.
  */
 
 /*
- *  NOTE: The spacing in the use of these macros
- *        is critical to them working as advertised.
- *
  *  COPYRIGHT:
  *
  *  This file is based on similar code found in newlib available
@@ -38,24 +41,24 @@
 
 #ifndef __USER_LABEL_PREFIX__
 /**
- *  Recent versions of GNU cpp define variables which indicate the
+ * Recent versions of GNU cpp define variables which indicate the
- *  need for underscores and percents.  If not using GNU cpp or
+ * need for underscores and percents.  If not using GNU cpp or
- *  the version does not support this, then you will obviously
+ * the version does not support this, then you will obviously
- *  have to define these as appropriate.
+ * have to define these as appropriate.
  *
- *  This symbol is prefixed to all C program symbols.
+ * This symbol is prefixed to all C program symbols.
  */
 #define __USER_LABEL_PREFIX__ _
 #endif
 
 #ifndef __REGISTER_PREFIX__
 /**
- *  Recent versions of GNU cpp define variables which indicate the
+ * Recent versions of GNU cpp define variables which indicate the
- *  need for underscores and percents.  If not using GNU cpp or
+ * need for underscores and percents.  If not using GNU cpp or
- *  the version does not support this, then you will obviously
+ * the version does not support this, then you will obviously
- *  have to define these as appropriate.
+ * have to define these as appropriate.
  *
- *  This symbol is prefixed to all register names.
+ * This symbol is prefixed to all register names.
  */
 #define __REGISTER_PREFIX__
 #endif
@@ -95,8 +98,9 @@
 #define BEGIN_DATA
 /** This macro is used to denote the end of a data section. */
 #define END_DATA
-/** This macro is used to denote the beginning of the
+/**
- *  unitialized data section.
+ * This macro is used to denote the beginning of the
+ * unitialized data section.
  */
 #define BEGIN_BSS
 /** This macro is used to denote the end of the unitialized data section.  */
@@ -105,18 +109,18 @@
 #define END
 
 /**
- *  This macro is used to declare a public global symbol.
+ * This macro is used to declare a public global symbol.
  *
- *  @note This must be tailored for a particular flavor of the C compiler.
+ * @note This must be tailored for a particular flavor of the C compiler.
- *  They may need to put underscores in front of the symbols.
+ * They may need to put underscores in front of the symbols.
  */
 #define PUBLIC(sym) .globl SYM (sym)
 
 /**
- *  This macro is used to prototype a public global symbol.
+ * This macro is used to prototype a public global symbol.
  *
- *  @note This must be tailored for a particular flavor of the C compiler.
+ * @note This must be tailored for a particular flavor of the C compiler.
- *  They may need to put underscores in front of the symbols.
+ * They may need to put underscores in front of the symbols.
  */
 #define EXTERN(sym) .globl SYM (sym)
 

cpukit/score/cpu/bfin/rtems/bfin/bf52x.h

@@ -1,13 +1,17 @@
 /**
- *@file bf52x.h
+ * @file
  *
- *  This file defines basic MMR for the Blackfin 52x CPU.
+ * @brief Basic MMR for the Blackfin 52x CPU
- *  The MMR have been taken from the ADSP-BF52x Blackfin Processor
- *  Hardware Reference from Analog Devices. Mentioned Chapters
- *  refer to this Documentation.
  *
- *	Based on bf533.h
+ * This file defines basic MMR for the Blackfin 52x CPU.
+ * The MMR have been taken from the ADSP-BF52x Blackfin Processor
+ * Hardware Reference from Analog Devices. Mentioned Chapters
+ * refer to this Documentation.
  *
+ * Based on bf533.h
+ */
+
+/*
  *  COPYRIGHT (c) 2006.
  *  Atos Automacao Industrial LTDA.
  *             modified by Alain Schaefer <alain.schaefer@easc.ch>
@@ -18,11 +22,8 @@
  *  http://www.rtems.com/license/LICENSE.
  *
  *
- * @author    Rohan Kangralkar, ECE Department Northeastern University
+ * Author:    Rohan Kangralkar, ECE Department Northeastern University
- * @date	  02/15/2011
+ * Date:	  02/15/2011
- *
- * HISTORY:
- *
  */
 
 #ifndef _RTEMS_BFIN_52x_H

cpukit/score/cpu/bfin/rtems/bfin/bf533.h

@@ -1,14 +1,18 @@
-/*  bfin.h
+/**
+ * @file
  *
- *  This file defines basic MMR for the Blackfin 531/532/533 CPU.
+ * @brief Basic MMR for the Blackfin 531/532/533 CPU
- *  The MMR have been taken from the ADSP-BF533 Blackfin Processor
- *  Hardware Reference from Analog Devices. Mentioned Chapters
- *  refer to this Documentation.
  *
- *  The Blackfins MMRs are divided into core MMRs (0xFFE0 0000–0xFFFF FFFF)
+ * This file defines basic MMR for the Blackfin 531/532/533 CPU.
- *  and System MMRs (0xFFC0 0000–0xFFE0 0000). The core MMRs are defined
+ * The MMR have been taken from the ADSP-BF533 Blackfin Processor
- *  in bfin.h which is included.
+ * Hardware Reference from Analog Devices. Mentioned Chapters
+ * refer to this Documentation.
  *
+ * The Blackfins MMRs are divided into core MMRs (0xFFE0 0000–0xFFFF FFFF)
+ * and System MMRs (0xFFC0 0000–0xFFE0 0000). The core MMRs are defined
+ * in bfin.h which is included.
+ */
+/*
  *  COPYRIGHT (c) 2006.
  *  Atos Automacao Industrial LTDA.
  *             modified by Alain Schaefer <alain.schaefer@easc.ch>

cpukit/score/cpu/bfin/rtems/bfin/bfin.h

@@ -1,8 +1,12 @@
-/*  bfin.h
+/**
+ * @file
  *
- *  This file defines Macros for MMR register common to all Blackfin
+ * @brief Macros for MMR register common to all Blackfin Processors
- *  Processors.
  *
+ * This file defines Macros for MMR register common to all Blackfin
+ * Processors.
+ */
+/*
  *  COPYRIGHT (c) 2006 by Atos Automacao Industrial Ltda.
  *             modified by Alain Schaefer <alain.schaefer@easc.ch>
  *                     and Antonio Giovanini <antonio@atos.com.br>

cpukit/score/cpu/bfin/rtems/score/bfin.h

@@ -1,10 +1,16 @@
-/*  bfin.h
+/**
+ * @file
  *
- *  This file sets up basic CPU dependency settings based on
+ * @brief Blackfin Set up Basic CPU Dependency Settings Based on
- *  compiler settings.  For example, it can determine if
+ * Compiler Settings
- *  floating point is available.  This particular implementation
- *  is specified to the Blackfin port.
  *
+ * This file sets up basic CPU dependency settings based on
+ * compiler settings.  For example, it can determine if
+ * floating point is available.  This particular implementation
+ * is specified to the Blackfin port.
+ */
+
+/*
  *
  *  COPYRIGHT (c) 1989-2006.
  *  On-Line Applications Research Corporation (OAR).

cpukit/score/cpu/bfin/rtems/score/cpu_asm.h

@@ -1,10 +1,12 @@
 /**
- * @file rtems/score/cpu_asm.h
+ * @file
+ *
+ * @brief Blackfin Assembly File
+ *
+ * Defines a couple of Macros used in cpu_asm.S
  */
 
 /*
- *  Defines a couple of Macros used in cpu_asm.S
- *
  *  COPYRIGHT (c) 2006 by Atos Automacao Industrial Ltda.
  *             written by Alain Schaefer <alain.schaefer@easc.ch>
  *                    and Antonio Giovanini <antonio@atos.com.br>

cpukit/score/cpu/bfin/rtems/score/types.h

@@ -1,7 +1,13 @@
-/*
+/**
- *  This include file contains type definitions pertaining to the
+ * @file
- *  Blackfin processor family.
  *
+ * @brief Blackfin CPU Type Definitions
+ *
+ * This include file contains type definitions pertaining to the
+ * Blackfin processor family.
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2006.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/score/cpu/nios2/rtems/score/cpu.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Altera Nios II CPU Department Source
+ */
+
 /*
  *  Copyright (c) 2011 embedded brains GmbH
  *
@@ -253,8 +259,8 @@ void _CPU_Initialize_vectors( void );
  * _CPU_ISR_Disable().  The value is not modified.
  *
  * This flash code is optimal for all Nios II configurations.  The rdctl does
- * not flush the pipeline and has only a late result penalty.  The wrctl on the
+ * not flush the pipeline and has only a late result penalty.  The wrctl on
- * other hand leads to a pipeline flush.
+ * the other hand leads to a pipeline flush.
  */
 #define _CPU_ISR_Flash( _isr_cookie ) \
   do { \
@@ -319,14 +325,12 @@ void _CPU_Context_Initialize(
 void _CPU_Fatal_halt( uint32_t _error ) RTEMS_COMPILER_NO_RETURN_ATTRIBUTE;
 
 /**
- * @brief CPU Initialize
+ * @brief CPU initialization.
- *
  */
 void _CPU_Initialize( void );
 
 /**
- * @brief CPU ISR Install Raw Handler
+ * @brief CPU ISR install raw handler.
- *
  */
 void _CPU_ISR_install_raw_handler(
   uint32_t vector,
@@ -335,8 +339,7 @@ void _CPU_ISR_install_raw_handler(
 );
 
 /**
- * @brief CPU ISR Install Vector.
+ * @brief CPU ISR install vector.
- *
  */
 void _CPU_ISR_install_vector(
   uint32_t vector,

cpukit/score/cpu/nios2/rtems/score/cpu_asm.h

@@ -1,12 +1,14 @@
 /**
- * @file rtems/score/cpu_asm.h
+ * @file
+ *
+ * @brief Altera Nios II Assembly File
+ *
+ * Very loose template for an include file for the cpu_asm.? file
+ * if it is implemented as a ".S" file (preprocessed by cpp) instead
+ * of a ".s" file (preprocessed by gm4 or gasp).
  */
 
 /*
- *  Very loose template for an include file for the cpu_asm.? file
- *  if it is implemented as a ".S" file (preprocessed by cpp) instead
- *  of a ".s" file (preprocessed by gm4 or gasp).
- *
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/score/cpu/nios2/rtems/score/types.h

@@ -1,11 +1,13 @@
 /**
- * @file rtems/score/types.h
+ * @file
+ *
+ * @brief Altera Nios II CPU Type Definitions
+ *
+ * This include file contains type definitions pertaining to the
+ * Altera Nios II processor family.
  */
 
 /*
- *  This include file contains type definitions pertaining to the
- *  Altera Nios II processor family.
- *
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/score/cpu/sh/rtems/asm.h

@@ -1,20 +1,23 @@
 /**
- * @file rtems/asm.h
+ * @file
  *
- *  This include file attempts to address the problems
+ * @brief Address the Problems Caused by Incompatible Flavor of
- *  caused by incompatible flavors of assemblers and
+ * Assemblers and Toolsets
- *  toolsets.  It primarily addresses variations in the
+ *
- *  use of leading underscores on symbols and the requirement
+ * This include file attempts to address the problems
- *  that register names be preceded by a %.
+ * caused by incompatible flavors of assemblers and
+ * toolsets.  It primarily addresses variations in the
+ * use of leading underscores on symbols and the requirement
+ * that register names be preceded by a %.
+ *
+ * @note The spacing in the use of these macros
+ *       is critical to them working as advertised.
  */
 
 /*
  *  Authors: Ralf Corsepius (corsepiu@faw.uni-ulm.de) and
  *           Bernd Becker (becker@faw.uni-ulm.de)
  *
- *  NOTE: The spacing in the use of these macros
- *        is critical to them working as advertised.
- *
  *  COPYRIGHT:
  *
  *  This file is based on similar code found in newlib available

cpukit/score/cpu/sh/rtems/score/sh.h

@@ -1,11 +1,13 @@
 /**
- * @file rtems/score/sh.h
+ * @file
+ *
+ * @brief Hitachi SH CPU Department Source
+ *
+ * This include file contains information pertaining to the Hitachi SH
+ * processor.
  */
 
 /*
- *  This include file contains information pertaining to the Hitachi SH
- *  processor.
- *
  *  Authors: Ralf Corsepius (corsepiu@faw.uni-ulm.de) and
  *           Bernd Becker (becker@faw.uni-ulm.de)
  *

cpukit/score/cpu/sh/rtems/score/sh_io.h

@@ -1,11 +1,13 @@
 /**
- * @file rtems/score/sh_io.h
+ * @file
+ *
+ * @brief Macros to Access Memory Mapped Devices on the SH7000-Architecture
+ *
+ * These are some macros to access memory mapped devices
+ * on the SH7000-architecture.
  */
 
 /*
- * These are some macros to access memory mapped devices
- * on the SH7000-architecture.
- *
  * Inspired from the linux kernel's include/asm/io.h
  *
  *  Authors: Ralf Corsepius (corsepiu@faw.uni-ulm.de) and

cpukit/score/cpu/sh/rtems/score/types.h

@@ -1,11 +1,13 @@
 /**
- * @file rtems/score/types.h
+ * @file
+ *
+ * @brief Hitachi SH CPU Type Definitions
+ *
+ * This include file contains information pertaining to the Hitachi SH
+ * processor.
  */
 
 /*
- *  This include file contains information pertaining to the Hitachi SH
- *  processor.
- *
  *  Authors: Ralf Corsepius (corsepiu@faw.uni-ulm.de) and
  *           Bernd Becker (becker@faw.uni-ulm.de)
  *

cpukit/score/cpu/v850/rtems/asm.h

@@ -1,26 +1,27 @@
 /**
- * @file rtems/asm.h
+ * @file
  *
- *  This include file attempts to address the problems
+ * @brief Address the Problems Caused by Incompatible Flavor of
- *  caused by incompatible flavors of assemblers and
+ * Assemblers and Toolsets
- *  toolsets.  It primarily addresses variations in the
+ *
- *  use of leading underscores on symbols and the requirement
+ * This include file attempts to address the problems
- *  that register names be preceded by a %.
+ * caused by incompatible flavors of assemblers and
+ * toolsets.  It primarily addresses variations in the
+ * use of leading underscores on symbols and the requirement
+ * that register names be preceded by a %.
+ *
+ * @note The spacing in the use of these macros
+ *       is critical to them working as advertised.
  */
 
 /*
- *  NOTE: The spacing in the use of these macros
- *        is critical to them working as advertised.
- *
  *  COPYRIGHT:
  *
  *  This file is based on similar code found in newlib available
  *  from ftp.cygnus.com.  The file which was used had no copyright
  *  notice.  This file is freely distributable as long as the source
  *  of the file is noted.  This file is:
- */
+ *
-
-/*
  *  COPYRIGHT (c) 1994-2012.
  *  On-Line Applications Research Corporation (OAR).
  */
@@ -40,24 +41,24 @@
 
 #ifndef __USER_LABEL_PREFIX__
 /**
- *  Recent versions of GNU cpp define variables which indicate the
+ * Recent versions of GNU cpp define variables which indicate the
- *  need for underscores and percents.  If not using GNU cpp or
+ * need for underscores and percents.  If not using GNU cpp or
- *  the version does not support this, then you will obviously
+ * the version does not support this, then you will obviously
- *  have to define these as appropriate.
+ * have to define these as appropriate.
  *
- *  This symbol is prefixed to all C program symbols.
+ * This symbol is prefixed to all C program symbols.
  */
 #define __USER_LABEL_PREFIX__ _
 #endif
 
 #ifndef __REGISTER_PREFIX__
 /**
- *  Recent versions of GNU cpp define variables which indicate the
+ * Recent versions of GNU cpp define variables which indicate the
- *  need for underscores and percents.  If not using GNU cpp or
+ * need for underscores and percents.  If not using GNU cpp or
- *  the version does not support this, then you will obviously
+ * the version does not support this, then you will obviously
- *  have to define these as appropriate.
+ * have to define these as appropriate.
  *
- *  This symbol is prefixed to all register names.
+ * This symbol is prefixed to all register names.
  */
 #define __REGISTER_PREFIX__
 #endif
@@ -97,8 +98,9 @@
 #define BEGIN_DATA
 /** This macro is used to denote the end of a data section. */
 #define END_DATA
-/** This macro is used to denote the beginning of the
+/**
- *  unitialized data section.
+ * This macro is used to denote the beginning of the
+ * unitialized data section.
  */
 #define BEGIN_BSS
 /** This macro is used to denote the end of the unitialized data section.  */
@@ -107,18 +109,18 @@
 #define END
 
 /**
- *  This macro is used to declare a public global symbol.
+ * This macro is used to declare a public global symbol.
  *
- *  @note This must be tailored for a particular flavor of the C compiler.
+ * @note This must be tailored for a particular flavor of the C compiler.
- *  They may need to put underscores in front of the symbols.
+ * They may need to put underscores in front of the symbols.
  */
 #define PUBLIC(sym) .globl SYM (sym)
 
 /**
- *  This macro is used to prototype a public global symbol.
+ * This macro is used to prototype a public global symbol.
  *
- *  @note This must be tailored for a particular flavor of the C compiler.
+ * @note This must be tailored for a particular flavor of the C compiler.
- *  They may need to put underscores in front of the symbols.
+ * They may need to put underscores in front of the symbols.
  */
 #define EXTERN(sym) .globl SYM (sym)
 

cpukit/score/cpu/v850/rtems/score/types.h

@@ -1,11 +1,13 @@
 /**
- * @file rtems/score/types.h
+ * @file
+ *
+ * @brief V850 CPU Type Definitions
+ *
+ * This include file contains type definitions pertaining to the
+ * v850 processor family.
  */
 
 /*
- *  This include file contains type definitions pertaining to the
- *  v850 processor family.
- *
  *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/score/cpu/v850/rtems/score/v850.h

@@ -1,8 +1,12 @@
-/*
+/**
- *  This file sets up basic CPU dependency settings based on
+ * @file
- *  compiler settings.  For example, it can determine if
+ *
- *  floating point is available.  This particular implementation
+ * @brief V850 Set up Basic CPU Dependency Settings Based on Compiler Settings
- *  is specified to the Renesas v850 port.
+ *
+ * This file sets up basic CPU dependency settings based on
+ * compiler settings.  For example, it can determine if
+ * floating point is available.  This particular implementation
+ * is specified to the Renesas v850 port.
  */
 
 /*