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

	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.
	* libmisc/monitor/mon-object.c, libmisc/monitor/monitor.h:
	Account for changing OBJECTS_NO_CLASS to OBJECTS_CLASSIC_NO_CLASS.
	* score/Doxyfile: Set output directory.  Predefine some macro values.
	Turn on graphical output.
	* score/include/rtems/debug.h, score/include/rtems/seterr.h,
	score/include/rtems/system.h, score/include/rtems/score/address.h,
	score/include/rtems/score/apiext.h,
	score/include/rtems/score/apimutex.h,
	score/include/rtems/score/bitfield.h,
	score/include/rtems/score/chain.h,
	score/include/rtems/score/context.h,
	score/include/rtems/score/coremsg.h,
	score/include/rtems/score/coremutex.h,
	score/include/rtems/score/coresem.h,
	score/include/rtems/score/heap.h, score/include/rtems/score/interr.h,
	score/include/rtems/score/isr.h, score/include/rtems/score/mpci.h,
	score/include/rtems/score/mppkt.h,
	score/include/rtems/score/object.h,
	score/include/rtems/score/objectmp.h,
	score/include/rtems/score/priority.h,
	score/include/rtems/score/stack.h,
	score/include/rtems/score/states.h,
	score/include/rtems/score/sysstate.h,
	score/include/rtems/score/thread.h,
	score/include/rtems/score/threadmp.h,
	score/include/rtems/score/threadq.h, score/include/rtems/score/tod.h,
	score/include/rtems/score/tqdata.h,
	score/include/rtems/score/userext.h,
	score/include/rtems/score/watchdog.h,
	score/include/rtems/score/wkspace.h,
	score/inline/rtems/score/address.inl,
	score/inline/rtems/score/chain.inl,
	score/inline/rtems/score/coremutex.inl,
	score/inline/rtems/score/coresem.inl,
	score/inline/rtems/score/heap.inl,
	score/inline/rtems/score/object.inl,
	score/inline/rtems/score/stack.inl,
	score/inline/rtems/score/thread.inl,
	score/inline/rtems/score/tqdata.inl, score/macros/README,
	score/src/heap.c, score/src/threadmp.c, score/src/threadready.c,
	score/src/threadstartmultitasking.c: Improve generated Doxygen
	output. Fix spelling and grammar errors in comments. Correct names of
	some variables and propagate changes.

1 files changed, 27 insertions, 14 deletions

diff --git a/cpukit/score/include/rtems/score/sysstate.h b/cpukit/score/include/rtems/score/sysstate.h
index 314c0bb2aa..fa53602688 100644
--- a/cpukit/score/include/rtems/score/sysstate.h
+++ b/cpukit/score/include/rtems/score/sysstate.h
@@ -5,7 +5,7 @@
  */
 
 /*
- *  COPYRIGHT (c) 1989-2004.
+ *  COPYRIGHT (c) 1989-2006.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
@@ -21,7 +21,8 @@
 /**
  *  @defgroup ScoreSysState System State Handler
  *
- *  This group contains functionality which XXX
+ *  This handler encapsulates functionality related to the management of the
+ *  internal system state of RTEMS.
  */
 /**@{*/
 
@@ -33,33 +34,45 @@ extern "C" {
 
 /* enumerated constants */
 
-/*
+/**
  *  The following type defines the possible system states.
  */
-
 typedef enum {
-  SYSTEM_STATE_BEFORE_INITIALIZATION,   /* start -> end of 1st init part */
-  SYSTEM_STATE_BEFORE_MULTITASKING,     /* end of 1st -> beginning of 2nd */
-  SYSTEM_STATE_BEGIN_MULTITASKING,      /* just before multitasking starts */
-  SYSTEM_STATE_UP,                      /* normal operation */
-  SYSTEM_STATE_SHUTDOWN,                /* shutdown */
-  SYSTEM_STATE_FAILED                   /* fatal error occurred */
+  /** This indicates that the system state is between the start
+   *  of rtems_initialize_executive_early and the end of the first
+   *  phase of initialization.
+   */
+  SYSTEM_STATE_BEFORE_INITIALIZATION,
+  /** This indicates that the system state is between end of the first
+   *  phase of initializatin but before  multitasking is started.
+   */
+  SYSTEM_STATE_BEFORE_MULTITASKING,
+  /** This indicates that the system state is attempting to initiate 
+   *  multitasking. 
+   */
+  SYSTEM_STATE_BEGIN_MULTITASKING,
+  /** This indicates that the system is up and operating normally. */
+  SYSTEM_STATE_UP,
+  /** This indicates that the system is in the midst of a shutdown. */
+  SYSTEM_STATE_SHUTDOWN,
+  /** This indicates that a fatal error has occurred. */
+  SYSTEM_STATE_FAILED
 } System_state_Codes;
 
+/** This defines the first system state. */
 #define SYSTEM_STATE_CODES_FIRST SYSTEM_STATE_BEFORE_INITIALIZATION
+/** This defines the highest value system state. */
 #define SYSTEM_STATE_CODES_LAST  SYSTEM_STATE_FAILED
 
-/*
+/**
  *  The following variable indicates whether or not this is
  *  an multiprocessing system.
  */
-
 SCORE_EXTERN boolean _System_state_Is_multiprocessing;
 
-/*
+/**
  *  The following variable contains the current system state.
  */
-
 SCORE_EXTERN System_state_Codes _System_state_Current;
 
 /*