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, 10 insertions, 30 deletions

diff --git a/cpukit/score/include/rtems/debug.h b/cpukit/score/include/rtems/debug.h
index 31f0005709..abdb6200d0 100644
--- a/cpukit/score/include/rtems/debug.h
+++ b/cpukit/score/include/rtems/debug.h
@@ -7,7 +7,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
@@ -24,69 +24,49 @@
 extern "C" {
 #endif
 
-/*
+/**
  *  The following type is used to manage the debug mask.
  */
-
 typedef uint32_t   rtems_debug_control;
 
 /*
  *  These constants represent various classes of debugging.
  */
 
+/** Macro which indicates that all debugging modes are enabled */
 #define RTEMS_DEBUG_ALL_MASK 0xffffffff
+
+/** Macro which indicates that debugging for heaps/regions is enabled */
 #define RTEMS_DEBUG_REGION   0x00000001
 
-/*
+/**
  *  This variable contains the current debug level.
  */
-
 SCORE_EXTERN rtems_debug_control _Debug_Level;
 
-/*
- *  _Debug_Manager_initialization
- *
- *  DESCRIPTION:
- *
+/**
  *  This routine performs the initialization necessary for this manager.
  */
-
 void _Debug_Manager_initialization( void );
 
-/*
- *  rtems_debug_enable
- *
- *  DESCRIPTION:
- *
+/**
  *  This routine enables the specified types of debug checks.
  */
-
 void rtems_debug_enable (
   rtems_debug_control  to_be_enabled
 );
 
-/*
- *  rtems_debug_disable
- *
- *  DESCRIPTION:
- *
+/**
  *  This routine disables the specified types of debug checks.
  */
-
 void rtems_debug_disable (
   rtems_debug_control  to_be_disabled
 );
 
-/*
- *
- *  _Debug_Is_enabled
- *
- *  DESCRIPTION:
- *
+/**
  *  This routine returns TRUE if the requested debug level is
  *  enabled, and FALSE otherwise.
  */
-
 boolean _Debug_Is_enabled(
   rtems_debug_control  level
 );