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, 6 insertions, 5 deletions

diff --git a/cpukit/score/include/rtems/score/wkspace.h b/cpukit/score/include/rtems/score/wkspace.h
index f438c39e1e..2fcc22a0aa 100644
--- a/cpukit/score/include/rtems/score/wkspace.h
+++ b/cpukit/score/include/rtems/score/wkspace.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
@@ -23,7 +23,8 @@
 /**
  *  @defgroup ScoreWorkspace Workspace Handler
  *
- *  This group contains functionality which XXX
+ *  This handler encapsulates functionality related to the management of
+ *  the RTEMS Executive Workspace.
  */
 /**@{*/
 
@@ -45,9 +46,9 @@ SCORE_EXTERN Heap_Control _Workspace_Area;  /* executive heap header */
  *
  *  This routine performs the initialization necessary for this handler.
  *
- *  @param starting_address (in) is the base address of the RTEMS Executive
+ *  @param[in] starting_address is the base address of the RTEMS Executive
  *         Workspace
- *  @param size (in) is the number of bytes in the RTEMS Executive Workspace
+ *  @param[in] size is the number of bytes in the RTEMS Executive Workspace
  */
 void _Workspace_Handler_initialization(
   void       *starting_address,
@@ -60,7 +61,7 @@ void _Workspace_Handler_initialization(
  *  bytes.  If a block of the appropriate size cannot be allocated
  *  from the workspace, then the internal error handler is invoked.
  *
- *  @param size (in) is the desired number of bytes to allocate
+ *  @param[in] size is the desired number of bytes to allocate
  *  @return If successful, the starting address of the allocated memory
  */
 void *_Workspace_Allocate_or_fatal_error(