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, 15 insertions, 15 deletions

diff --git a/cpukit/score/include/rtems/score/coresem.h b/cpukit/score/include/rtems/score/coresem.h
index 866e59d360..54621fce84 100644
--- a/cpukit/score/include/rtems/score/coresem.h
+++ b/cpukit/score/include/rtems/score/coresem.h
@@ -8,7 +8,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,7 +24,7 @@
 /**
  *  @defgroup ScoreSemaphore Semaphore Handler
  *
- *  This group contains functionality which provides the foundation
+ *  This handler encapsulates functionality which provides the foundation
  *  Semaphore services used in all of the APIs supported by RTEMS.
  */
 /**@{*/
@@ -118,9 +118,9 @@ typedef struct {
 /**
  *  This routine initializes the semaphore based on the parameters passed.
  *
- *  @param the_semaphore (in) is the semaphore to initialize
- *  @param the_semaphore_attributes (in) define the behavior of this instance
- *  @param initial_value (in) is the initial count of the semaphore
+ *  @param[in] the_semaphore is the semaphore to initialize
+ *  @param[in] the_semaphore_attributes define the behavior of this instance
+ *  @param[in] initial_value is the initial count of the semaphore
  */
 void _CORE_semaphore_Initialize(
   CORE_semaphore_Control       *the_semaphore,
@@ -134,11 +134,11 @@ void _CORE_semaphore_Initialize(
  *  returns.  Otherwise, the calling task is blocked until a unit becomes
  *  available.
  *
- *  @param the_semaphore (in) is the semaphore to seize
- *  @param id (in) is the Id of the API level Semaphore object associated
+ *  @param[in] the_semaphore is the semaphore to seize
+ *  @param[in] id is the Id of the API level Semaphore object associated
  *         with this instance of a SuperCore Semaphore
- *  @param wait (in) is TRUE if the calling thread is willing to wait
- *  @param timeout (in) is the number of ticks the calling thread is willing
+ *  @param[in] wait is TRUE if the calling thread is willing to wait
+ *  @param[in] timeout is the number of ticks the calling thread is willing
  *         to wait if @a wait is TRUE.
  */
 void _CORE_semaphore_Seize(
@@ -153,10 +153,10 @@ void _CORE_semaphore_Seize(
  *  for a unit from this semaphore, then that task will be readied and the unit
  *  given to that task.  Otherwise, the unit will be returned to the semaphore.
  *
- *  @param the_semaphore (in) is the semaphore to surrender
- *  @param id (in) is the Id of the API level Semaphore object associated
+ *  @param[in] the_semaphore is the semaphore to surrender
+ *  @param[in] id is the Id of the API level Semaphore object associated
  *         with this instance of a SuperCore Semaphore
- *  @param api_semaphore_mp_support (in) is the routine to invoke if the
+ *  @param[in] api_semaphore_mp_support is the routine to invoke if the
  *         thread unblocked is remote
  *
  *  @return an indication of whether the routine succeeded or failed
@@ -171,10 +171,10 @@ CORE_semaphore_Status _CORE_semaphore_Surrender(
  *  This routine assists in the deletion of a semaphore by flushing the
  *  associated wait queue.
  *
- *  @param the_semaphore (in) is the semaphore to flush
- *  @param remote_extract_callout (in) is the routine to invoke if the
+ *  @param[in] the_semaphore is the semaphore to flush
+ *  @param[in] remote_extract_callout is the routine to invoke if the
  *         thread unblocked is remote
- *  @param status (in) is the status to be returned to the unblocked thread
+ *  @param[in] status is the status to be returned to the unblocked thread
  */
 void _CORE_semaphore_Flush(
   CORE_semaphore_Control         *the_semaphore,