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, 26 insertions, 9 deletions

diff --git a/cpukit/score/include/rtems/score/watchdog.h b/cpukit/score/include/rtems/score/watchdog.h
index 124187c899..fc902ad8c7 100644
--- a/cpukit/score/include/rtems/score/watchdog.h
+++ b/cpukit/score/include/rtems/score/watchdog.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,11 @@
 /**
  *  @defgroup ScoreWatchdog Watchdog Handler
  *
- *  This group contains functionality which XXX
+ *  This handler encapsulates functionality related to the scheduling of
+ *  watchdog functions to be called at specific times in the future.
+ *
+ *  @note This handler does not have anything to do with hardware watchdog
+ *        timers.
  */
 /**@{*/
 
@@ -109,14 +113,27 @@ typedef enum {
  *  to manage each watchdog timer.
  */
 typedef struct {
+  /** This field is a Chain Node structure and allows this to be placed on
+   *  chains for set management.
+   */
   Chain_Node                      Node;
+  /** This field is the state of the watchdog. */
   Watchdog_States                 state;
+  /** This field is the initially requested interval. */
   Watchdog_Interval               initial;
+  /** This field is the remaining portion of the interval. */
   Watchdog_Interval               delta_interval;
+  /** This field is the number of system clock ticks when this was scheduled. */
   Watchdog_Interval               start_time;
+  /** This field is the number of system clock ticks when this was suspended. */
   Watchdog_Interval               stop_time;
+  /** This field is the function to invoke. */
   Watchdog_Service_routine_entry  routine;
+  /** This field is the Id to pass as an argument to the routine. */
   Objects_Id                      id;
+  /** This field is an untyped pointer to user data that is passed to the
+   *  watchdog handler routine.
+   */
   void                           *user_data;
 }   Watchdog_Control;
 
@@ -166,7 +183,7 @@ void _Watchdog_Handler_initialization( void );
  *  This routine removes @a the_watchdog from the watchdog chain on which
  *  it resides and returns the state @a the_watchdog timer was in.
  *  
- *  @param the_watchdog (in) will be removed
+ *  @param[in] the_watchdog will be removed
  *  @return the state in which @a the_watchdog was in when removed
  */
 Watchdog_States _Watchdog_Remove (
@@ -178,9 +195,9 @@ Watchdog_States _Watchdog_Remove (
  *  This routine adjusts the @a header watchdog chain in the forward
  *  or backward @a direction for @a units ticks.
  *
- *  @param header (in) is the watchdog chain to adjust
- *  @param direction (in) is the direction to adjust @a header
- *  @param units (in) is the number of units to adjust @a header
+ *  @param[in] header is the watchdog chain to adjust
+ *  @param[in] direction is the direction to adjust @a header
+ *  @param[in] units is the number of units to adjust @a header
  */
 void _Watchdog_Adjust (
   Chain_Control              *header,
@@ -193,8 +210,8 @@ void _Watchdog_Adjust (
  *  This routine inserts @a the_watchdog into the @a header watchdog chain
  *  for a time of @a units.  
  *
- *  @param header (in) is @a the_watchdog list to insert @a the_watchdog on
- *  @param the_watchdog (in) is the watchdog to insert
+ *  @param[in] header is @a the_watchdog list to insert @a the_watchdog on
+ *  @param[in] the_watchdog is the watchdog to insert
  */
 void _Watchdog_Insert (
   Chain_Control         *header,
@@ -206,7 +223,7 @@ void _Watchdog_Insert (
  *  This routine is invoked at appropriate intervals to update
  *  the @a header watchdog chain.
  *
- *  @param header (in) is the watchdog chain to tickle
+ *  @param[in] header is the watchdog chain to tickle
  */
 
 void _Watchdog_Tickle (