2006-01-16 Joel Sherrill <joel@OARcorp.com>

	* rtems/asm.h, rtems/score/cpu.h, rtems/score/types.h: Part of a large
	patch to improve Doxygen output. As a side-effect, grammar and
	spelling errors were corrected, spacing errors were address, and some
	variable names were improved.

1 files changed, 39 insertions, 11 deletions

diff --git a/cpukit/score/cpu/no_cpu/rtems/asm.h b/cpukit/score/cpu/no_cpu/rtems/asm.h
index 066b6f86ef..7dd89312b7 100644
--- a/cpukit/score/cpu/no_cpu/rtems/asm.h
+++ b/cpukit/score/cpu/no_cpu/rtems/asm.h
@@ -19,7 +19,7 @@
  *  notice.  This file is freely distributable as long as the source
  *  of the file is noted.  This file is:
  *
- *  COPYRIGHT (c) 1994-1997.
+ *  COPYRIGHT (c) 1994-2006.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  $Id$
@@ -38,29 +38,36 @@
 #include <rtems/score/cpuopts.h>
 #include <rtems/score/no_cpu.h>
 
-/*
+#ifndef __USER_LABEL_PREFIX__
+/**
  *  Recent versions of GNU cpp define variables which indicate the
  *  need for underscores and percents.  If not using GNU cpp or
  *  the version does not support this, then you will obviously
  *  have to define these as appropriate.
+ *
+ *  This symbol is prefixed to all C program symbols.
  */
-
-#ifndef __USER_LABEL_PREFIX__
 #define __USER_LABEL_PREFIX__ _
 #endif
 
 #ifndef __REGISTER_PREFIX__
+/**
+ *  Recent versions of GNU cpp define variables which indicate the
+ *  need for underscores and percents.  If not using GNU cpp or
+ *  the version does not support this, then you will obviously
+ *  have to define these as appropriate.
+ *
+ *  This symbol is prefixed to all register names.
+ */
 #define __REGISTER_PREFIX__
 #endif
 
 #include <rtems/concat.h>
 
-/* Use the right prefix for global labels.  */
-
+/** Use the right prefix for global labels.  */
 #define SYM(x) CONCAT1 (__USER_LABEL_PREFIX__, x)
 
-/* Use the right prefix for registers.  */
-
+/** Use the right prefix for registers.  */
 #define REG(x) CONCAT1 (__REGISTER_PREFIX__, x)
 
 /*
@@ -74,24 +81,45 @@
  */
 
 
+/** This macro is used to denote the beginning of a code declaration. */
 #define BEGIN_CODE_DCL .text
+/** This macro is used to denote the end of a code declaration. */
 #define END_CODE_DCL
+/** This macro is used to denote the beginning of a data declaration section. */
 #define BEGIN_DATA_DCL .data
+/** This macro is used to denote the end of a data declaration section. */
 #define END_DATA_DCL
+/** This macro is used to denote the beginning of a code section. */
 #define BEGIN_CODE .text
+/** This macro is used to denote the end of a code section. */
 #define END_CODE
+/** This macro is used to denote the beginning of a data section. */
 #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.
+ */
 #define BEGIN_BSS
+/** This macro is used to denote the end of the unitialized data section.  */
 #define END_BSS
+/** This macro is used to denote the end of the assembly file.  */
 #define END
 
-/*
- *  Following must be tailor for a particular flavor of the C compiler.
+/**
+ *  This macro is used to declare a public global symbol.
+ *
+ *  @note This must be tailored for a particular flavor of the C compiler.
  *  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.
+ *
+ *  @note This must be tailored for a particular flavor of the C compiler.
+ *  They may need to put underscores in front of the symbols.
+ */
 #define EXTERN(sym) .globl SYM (sym)
 
 #endif