score: Doxygen Clean Up Task #14

20 files changed, 290 insertions, 30 deletions

diff --git a/cpukit/score/cpu/avr/avr/io4414.h b/cpukit/score/cpu/avr/avr/io4414.h
index 9c8362c061..94460a426e 100644
--- a/cpukit/score/cpu/avr/avr/io4414.h
+++ b/cpukit/score/cpu/avr/avr/io4414.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Definitions for AT90S4414
+ *
+ * This file should only be included from <avr/io.h>, never directly.
+ */
+
 /* Copyright (c) 2002, Marek Michalkiewicz
    All rights reserved.
 
@@ -46,6 +54,14 @@
 #  error "Attempt to include more than one <avr/ioXXX.h> file."
 #endif 
 
+/**
+ * @defgroup AvrDef_io4414 AT90S4414 Definitions
+ *
+ * @ingroup avr
+ *
+ * @{
+ */
+
 /* I/O registers */
 
 /* Analog Comparator Control and Status Register */
@@ -480,5 +496,6 @@
 #define SIGNATURE_1 0x92
 #define SIGNATURE_2 0x01
 
+/** @} */
 
 #endif /* _AVR_IO4414_H_ */
diff --git a/cpukit/score/cpu/avr/avr/io76c711.h b/cpukit/score/cpu/avr/avr/io76c711.h
index 60e3b744a3..f4690761f8 100644
--- a/cpukit/score/cpu/avr/avr/io76c711.h
+++ b/cpukit/score/cpu/avr/avr/io76c711.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Definitions for AT76C711
+ *
+ * This file should only be included from <avr/io.h>, never directly.
+ */
+
 /* Copyright (c) 2002, Marek Michalkiewicz
    All rights reserved.
 
@@ -46,6 +54,14 @@
 #  error "Attempt to include more than one <avr/ioXXX.h> file."
 #endif 
 
+/**
+ * @defgroup AvrDef_io76c711 AT76C711 Definitions
+ *
+ * @ingroup avr
+ *
+ * @{
+ */
+
 /* I/O registers */
 
 /* 0x00-0x0C reserved */
@@ -489,4 +505,7 @@
    0x8000 - 0xBFFF - program SRAM (read/write), would be nice if other
                      AVR devices did that as well (no need to use LPM!)
  */
+
+/** @} */
+
 #endif /* _AVR_IO76C711_H_ */
diff --git a/cpukit/score/cpu/avr/avr/io8534.h b/cpukit/score/cpu/avr/avr/io8534.h
index f25cfd269f..10e20b34ed 100644
--- a/cpukit/score/cpu/avr/avr/io8534.h
+++ b/cpukit/score/cpu/avr/avr/io8534.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Definitions for AT90C8534
+ *
+ * This file should only be included from <avr/io.h>, never directly.
+ */
+
 /* Copyright (c) 2002, Marek Michalkiewicz
    All rights reserved.
 
@@ -46,6 +54,14 @@
 #  error "Attempt to include more than one <avr/ioXXX.h> file."
 #endif 
 
+/**
+ * @defgroup AvrDef_io8534 AT90C8534 Definitions
+ *
+ * @ingroup avr
+ *
+ * @{
+ */
+
 /* I/O registers */
 
 /* 0x00..0x03 reserved */
@@ -212,4 +228,6 @@
 #define E2END		0x1FF
 #define FLASHEND	0x1FFF
 
+/** @} */
+
 #endif /* _AVR_IO8534_H_ */
diff --git a/cpukit/score/cpu/avr/avr/io90pwm1.h b/cpukit/score/cpu/avr/avr/io90pwm1.h
index ccf77afd07..d893fd9090 100644
--- a/cpukit/score/cpu/avr/avr/io90pwm1.h
+++ b/cpukit/score/cpu/avr/avr/io90pwm1.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Definitions for AT90PWM1
+ *
+ * This file should only be included from <avr/io.h>, never directly.
+ */
+
 /* Copyright (c) 2005, Andrey Pashchenko
    Copyright (c) 2007, Anatoly Sokolov
    All rights reserved.
@@ -47,6 +55,14 @@
 #  error "Attempt to include more than one <avr/ioXXX.h> file."
 #endif 
 
+/**
+ * @defgroup AvrDef_io90pwm1 AT90PWM1 Definitions
+ *
+ * @ingroup avr
+ *
+ * @{
+ */
+
 /* I/O registers */
 
 /* Reserved [0x00..0x02] */
@@ -1116,5 +1132,6 @@
 #define __BOOT_LOCK_BITS_0_EXIST
 #define __BOOT_LOCK_BITS_1_EXIST 
 
+/** @} */
 
 #endif /* _AVR_IOPWM1_H_ */
diff --git a/cpukit/score/cpu/avr/avr/io90pwm216.h b/cpukit/score/cpu/avr/avr/io90pwm216.h
index 70682e7bcd..7a53cf0645 100644
--- a/cpukit/score/cpu/avr/avr/io90pwm216.h
+++ b/cpukit/score/cpu/avr/avr/io90pwm216.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Definitions for AT90PWM216
+ *
+ * This file should only be included from <avr/io.h>, never directly.
+ */
+
 /* Copyright (c) 2007, Atmel Corporation
    All rights reserved.
 
@@ -46,6 +54,14 @@
 #  error "Attempt to include more than one <avr/ioXXX.h> file."
 #endif 
 
+/**
+ * @defgroup AvrDef_io90pwm216 AT90PWM216 Definitions
+ *
+ * @ingroup avr
+ *
+ * @{
+ */
+
 /* I/O registers */
 
 /* Port B Input Pins Address */
@@ -1176,5 +1192,6 @@
 #define SIGNATURE_1 0x94
 #define SIGNATURE_2 0x83
 
+/** @} */
 
 #endif /* _AVR_IO90PWM216_H_ */
diff --git a/cpukit/score/cpu/avr/avr/io90pwm3b.h b/cpukit/score/cpu/avr/avr/io90pwm3b.h
index 0d648fb47d..7885ec9fb5 100644
--- a/cpukit/score/cpu/avr/avr/io90pwm3b.h
+++ b/cpukit/score/cpu/avr/avr/io90pwm3b.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Definitions for AT90PWM3B
+ *
+ * This file should only be included from <avr/io.h>, never directly.
+ */
+
 /* Copyright (c) 2007 Atmel Corporation
    All rights reserved.
 
@@ -48,6 +56,14 @@
 #ifndef _AVR_IO90PWM3B_H_
 #define _AVR_IO90PWM3B_H_ 1
 
+/**
+ * @defgroup AvrDef_io90pwm3b AT90PWM3B Definitions
+ *
+ * @ingroup avr
+ *
+ * @{
+ */
+
 /* Registers and associated bit numbers */
 
 #define PINB _SFR_IO8(0x03)
@@ -1387,5 +1403,6 @@
 #define SIGNATURE_1 0x93
 #define SIGNATURE_2 0x83
 
+/** @} */
 
 #endif /* _AVR_IO90PWM3B_H_ */
diff --git a/cpukit/score/cpu/avr/avr/iom1280.h b/cpukit/score/cpu/avr/avr/iom1280.h
index 5bed7c9a43..933e7098a3 100644
--- a/cpukit/score/cpu/avr/avr/iom1280.h
+++ b/cpukit/score/cpu/avr/avr/iom1280.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Definitions for ATmega1280
+ */
+
 /* Copyright (c) 2005 Anatoly Sokolov 
    All rights reserved.
 
@@ -36,6 +42,14 @@
 
 #include <avr/iomxx0_1.h>
 
+/**
+ * @defgroup AvrDef_iom1280 ATmega1280 Definitions
+ *
+ * @ingroup avr
+ *
+ * @{
+ */
+
 /* Constants */
 #define SPM_PAGESIZE    256
 #define RAMEND          0x21FF
@@ -89,5 +103,6 @@
 #define SIGNATURE_1 0x97
 #define SIGNATURE_2 0x03
 
+/** @} */
 
 #endif /* _AVR_IOM1280_H_ */
diff --git a/cpukit/score/cpu/avr/avr/iom6450.h b/cpukit/score/cpu/avr/avr/iom6450.h
index 8317f18013..0a114297d9 100644
--- a/cpukit/score/cpu/avr/avr/iom6450.h
+++ b/cpukit/score/cpu/avr/avr/iom6450.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Definitions for ATmega6450
+ *
+ * This file should only be included from <avr/io.h>, never directly.
+ */
+
 /* Copyright (c) 2004,2005,2006 Eric B. Weddington
    All rights reserved.
 
@@ -46,6 +54,14 @@
 #  error "Attempt to include more than one <avr/ioXXX.h> file."
 #endif 
 
+/**
+ * @defgroup AvrDef_iom6450 ATmega6450 Definitions
+ *
+ * @ingroup avr
+ *
+ * @{
+ */
+
 /* Registers and associated bit numbers */
 
 #define PINA    _SFR_IO8(0x00)
@@ -902,5 +918,6 @@
 #define SIGNATURE_1 0x96
 #define SIGNATURE_2 0x06
 
+/** @} */
 
 #endif /* _AVR_IOM6450_H_ */
diff --git a/cpukit/score/cpu/avr/avr/iom64c1.h b/cpukit/score/cpu/avr/avr/iom64c1.h
index a30aee0d98..5d2ef5d42e 100644
--- a/cpukit/score/cpu/avr/avr/iom64c1.h
+++ b/cpukit/score/cpu/avr/avr/iom64c1.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Definitions for ATmega64C1
+ *
+ * This file should only be included from <avr/io.h>, never directly.
+ */
+
 /* Copyright (c) 2009 Atmel Corporation
    All rights reserved.
 
@@ -47,6 +55,13 @@
 #ifndef _AVR_ATmega64C1_H_
 #define _AVR_ATmega64C1_H_ 1
 
+/**
+ * @defgroup AvrDef_iom64c1 ATmega64C1 Definitions
+ *
+ * @ingroup avr
+ *
+ * @{
+ */
 
 /* Registers and associated bit numbers. */
 
@@ -1292,6 +1307,7 @@
 #define SIGNATURE_1 0x96
 #define SIGNATURE_2 0x86
 
+/** @} */
 
 #endif /* _AVR_ATmega64C1_H_ */
 
diff --git a/cpukit/score/cpu/avr/avr/iom8.h b/cpukit/score/cpu/avr/avr/iom8.h
index 02ad8e1ac3..c43ac86c3e 100644
--- a/cpukit/score/cpu/avr/avr/iom8.h
+++ b/cpukit/score/cpu/avr/avr/iom8.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Definitions for ATmega8
+ *
+ * This file should only be included from <avr/io.h>, never directly.
+ */
+
 /* Copyright (c) 2002, Marek Michalkiewicz
    All rights reserved.
 
@@ -46,6 +54,14 @@
 #  error "Attempt to include more than one <avr/ioXXX.h> file."
 #endif 
 
+/**
+ * @defgroup AvrDef_iom8 ATmega8 Definitions
+ *
+ * @ingroup avr
+ *
+ * @{
+ */
+
 /* I/O registers */
 
 /* TWI stands for "Two Wire Interface" or "TWI Was I2C(tm)" */
@@ -609,5 +625,6 @@
 #define SIGNATURE_1 0x93
 #define SIGNATURE_2 0x07
 
+/** @} */
 
 #endif /* _AVR_IOM8_H_ */
diff --git a/cpukit/score/cpu/avr/avr/iom88.h b/cpukit/score/cpu/avr/avr/iom88.h
index 063b1faecc..60ef3d2cae 100644
--- a/cpukit/score/cpu/avr/avr/iom88.h
+++ b/cpukit/score/cpu/avr/avr/iom88.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Definitions for ATmega88
+ */
+
 /* Copyright (c) 2004, Theodore A. Roth
    All rights reserved.
 
@@ -32,6 +38,14 @@
 #ifndef _AVR_IOM88_H_
 #define _AVR_IOM88_H_ 1
 
+/**
+ * @defgroup AvrDef_iom88 ATmega88 Definitions
+ *
+ * @ingroup avr
+ *
+ * @{
+ */
+
 #include <avr/iomx8.h>
 
 /* Constants */
@@ -86,5 +100,6 @@
 #define SIGNATURE_1 0x93
 #define SIGNATURE_2 0x0A
 
+/** @} */
 
 #endif /* _AVR_IOM88_H_ */
diff --git a/cpukit/score/cpu/avr/avr/iotn26.h b/cpukit/score/cpu/avr/avr/iotn26.h
index 068d7f98f8..8722055de9 100644
--- a/cpukit/score/cpu/avr/avr/iotn26.h
+++ b/cpukit/score/cpu/avr/avr/iotn26.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Definitions for ATtiny26
+ *
+ * This file should only be included from <avr/io.h>, never directly.
+ */
+
 /* Copyright (c) 2004,2005 Eric B. Weddington
    All rights reserved.
 
@@ -46,6 +54,14 @@
 #ifndef _AVR_IOTN26_H_
 #define _AVR_IOTN26_H_ 1
 
+/**
+ * @defgroup AvrDef_iotn26 ATtiny26 Definitions
+ *
+ * @ingroup avr
+ *
+ * @{
+ */
+
 /* Registers and associated bit numbers */
 
 /* Reserved [0x00..0x03] */
@@ -380,5 +396,6 @@
 #define SIGNATURE_1 0x91
 #define SIGNATURE_2 0x09
 
+/** @} */
 
 #endif  /* _AVR_IOTN26_H_ */
diff --git a/cpukit/score/cpu/avr/avr/iotn261.h b/cpukit/score/cpu/avr/avr/iotn261.h
index 6e18069b5b..9b91b7b0e0 100644
--- a/cpukit/score/cpu/avr/avr/iotn261.h
+++ b/cpukit/score/cpu/avr/avr/iotn261.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Definitions for ATtiny261
+ */
+
 /* Copyright (c) 2006, Anatoly Sokolov
    All rights reserved.
 
@@ -34,6 +40,14 @@
 #ifndef _AVR_IOTN261_H_
 #define _AVR_IOTN261_H_ 1
 
+/**
+ * @defgroup AvrDef_iotn261 ATtiny261 Definitions
+ *
+ * @ingroup avr
+ *
+ * @{
+ */
+
 #include <avr/iotnx61.h>
 
 #define SPM_PAGESIZE 32
@@ -83,5 +97,6 @@
 #define SIGNATURE_1 0x91
 #define SIGNATURE_2 0x0C
 
+/** @} */
 
 #endif /* _AVR_IOTN261_H_ */
diff --git a/cpukit/score/cpu/avr/avr/iousb82.h b/cpukit/score/cpu/avr/avr/iousb82.h
index 428ed9b566..94232af473 100644
--- a/cpukit/score/cpu/avr/avr/iousb82.h
+++ b/cpukit/score/cpu/avr/avr/iousb82.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Ddefinitions for AT90USB82
+ */
+
 /* Copyright (c) 2007 Anatoly Sokolov 
    All rights reserved.
 
@@ -36,6 +42,14 @@
 
 #include <avr/iousbxx2.h>
 
+/**
+ * @defgroup AvrDef_iousb82 AT90USB82 Definitions
+ *
+ * @ingroup avr
+ *
+ * @{
+ */
+
 /* Constants */
 #define SPM_PAGESIZE 128
 #define RAMEND       0x2FF
@@ -83,5 +97,6 @@
 #define __BOOT_LOCK_BITS_0_EXIST
 #define __BOOT_LOCK_BITS_1_EXIST 
 
+/** @} */
 
 #endif /* _AVR_AT90USB82_H_ */
diff --git a/cpukit/score/cpu/avr/avr/iox32d4.h b/cpukit/score/cpu/avr/avr/iox32d4.h
index 7f7d710704..0e01175ea6 100644
--- a/cpukit/score/cpu/avr/avr/iox32d4.h
+++ b/cpukit/score/cpu/avr/avr/iox32d4.h
@@ -1,6 +1,13 @@
+/**
+ * @file
+ *
+ * @brief Definitions for ATxmega32D4
+ *
+ * This file should only be included from <avr/io.h>, never directly.
+ */
+
 /* Copyright (c) 2009 Atmel Corporation
    All rights reserved.
-
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
 
@@ -47,6 +54,14 @@
 #ifndef _AVR_ATxmega32D4_H_
 #define _AVR_ATxmega32D4_H_ 1
 
+/**
+ * @defgroup AvrDef_iox32d4 ATxmega32D4 Definitions
+ *
+ * @ingroup avr
+ *
+ * @{
+ */
+
 
 /* Ungrouped common registers */
 #define GPIO0  _SFR_MEM8(0x0000)  /* General Purpose IO Register 0 */
@@ -5539,6 +5554,7 @@ IO Module Instances. Mapped to memory.
 #define SIGNATURE_1 0x95
 #define SIGNATURE_2 0x42
 
+/** @} */
 
 #endif /* _AVR_ATxmega32D4_H_ */
 
diff --git a/cpukit/score/cpu/avr/rtems/asm.h b/cpukit/score/cpu/avr/rtems/asm.h
index 89f1385b36..e93841d06e 100644
--- a/cpukit/score/cpu/avr/rtems/asm.h
+++ b/cpukit/score/cpu/avr/rtems/asm.h
@@ -1,17 +1,20 @@
 /**
- * @file rtems/asm.h
+ * @file
  *
- *  This include file attempts to address the problems
- *  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 %.
+ * @brief Address the Problems Caused by Incompatible Flavor of
+ * Assemblers and Toolsets
+ *
+ * This include file attempts to address the problems
+ * 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
@@ -324,7 +327,7 @@
 	lpm / mov Rd,r0
 	lpm / adiw ZL,1
 	lpm / mov Rd,r0 / adiw ZL,1
-	
+
    For enhanced chips it is one instruction always.
 
    ATTENTION:  unlike enhanced chips SREG (S,V,N,Z,C) flags are
diff --git a/cpukit/score/cpu/avr/rtems/score/avr.h b/cpukit/score/cpu/avr/rtems/score/avr.h
index 23ecbb3e76..cee1a24102 100644
--- a/cpukit/score/cpu/avr/rtems/score/avr.h
+++ b/cpukit/score/cpu/avr/rtems/score/avr.h
@@ -1,13 +1,16 @@
 /**
- * @file rtems/score/avr.h
+ * @file
+ *
+ * @brief Intel AVR Set up Basic CPU Dependency Settings Based on
+ * Compiler Settings
+ *
+ * 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 avr 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 avr port.
- *
  *  COPYRIGHT 2004, Ralf Corsepius, Ulm, Germany.
  *
  *  The license and distribution terms for this file may be
diff --git a/cpukit/score/cpu/avr/rtems/score/cpu.h b/cpukit/score/cpu/avr/rtems/score/cpu.h
index 2bfcbceaf9..5f1577af20 100644
--- a/cpukit/score/cpu/avr/rtems/score/cpu.h
+++ b/cpukit/score/cpu/avr/rtems/score/cpu.h
@@ -1,11 +1,13 @@
 /**
- * @file rtems/score/cpu.h
+ * @file
+ *
+ * @brief Intel AVR CPU Department Source
+ *
+ * This include file contains information pertaining to the AVR
+ * processor.
  */
 
 /*
- *  This include file contains information pertaining to the AVR
- *  processor.
- *
  *  COPYRIGHT (c) 1989-2006.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/score/cpu/avr/rtems/score/cpu_asm.h b/cpukit/score/cpu/avr/rtems/score/cpu_asm.h
index e3797a93f9..e11caec486 100644
--- a/cpukit/score/cpu/avr/rtems/score/cpu_asm.h
+++ b/cpukit/score/cpu/avr/rtems/score/cpu_asm.h
@@ -1,12 +1,14 @@
 /**
- * @file rtems/score/cpu_asm.h
+ * @file
+ *
+ * @brief Intel AVR 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).
  *
diff --git a/cpukit/score/cpu/avr/rtems/score/types.h b/cpukit/score/cpu/avr/rtems/score/types.h
index 77eb0dbc30..a4710d3331 100644
--- a/cpukit/score/cpu/avr/rtems/score/types.h
+++ b/cpukit/score/cpu/avr/rtems/score/types.h
@@ -1,11 +1,13 @@
 /**
- * @file rtems/score/types.h
+ * @file
+ *
+ * @brief Intel AVR CPU Type Definitions
+ *
+ * This include file contains type definitions pertaining to the Intel
+ * avr processor family.
  */
 
 /*
- *  This include file contains type definitions pertaining to the Intel
- *  avr processor family.
- *
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *