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, 14 insertions, 12 deletions

diff --git a/cpukit/score/include/rtems/score/mppkt.h b/cpukit/score/include/rtems/score/mppkt.h
index 1867ae45a9..b194610500 100644
--- a/cpukit/score/include/rtems/score/mppkt.h
+++ b/cpukit/score/include/rtems/score/mppkt.h
@@ -9,7 +9,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
@@ -25,7 +25,9 @@
 /**
  *  @defgroup ScoreMPPacket MP Packet Handler
  *
- *  This group contains functionality which XXX
+ *  This handler encapsulates the primary definition of MPCI packets.  This
+ *  handler defines the part of the packet that is common to all remote
+ *  operations.
  */
 /**@{*/
 
@@ -56,12 +58,12 @@ typedef enum {
 }   MP_packet_Classes;
 
 /**
- *  XXX
+ *  This constant defines the first entry in the MP_packet_Classes enumeration.
  */
 #define MP_PACKET_CLASSES_FIRST  MP_PACKET_MPCI_INTERNAL
 
 /**
- *  XXX
+ *  This constant defines the last entry in the MP_packet_Classes enumeration.
  */
 #define MP_PACKET_CLASSES_LAST   MP_PACKET_SIGNAL
 
@@ -74,21 +76,21 @@ typedef enum {
  *        alignment rule encountered yet.
  */
 typedef struct {
-  /** XXX */
+  /** This field indicates the API class of the operation being performed. */
   MP_packet_Classes       the_class;
-  /** XXX */
+  /** This field is the id of the object to be acted upon. */
   Objects_Id              id;
-  /** XXX */
+  /** This field is the ID of the originating thread. */
   Objects_Id              source_tid;
-  /** XXX */
+  /** This field is the priority of the originating thread. */
   Priority_Control        source_priority;
-  /** XXX */
+  /** This field is where the status of the operation will be returned. */
   uint32_t                return_code;
-  /** XXX */
+  /** This field is the length of the data following the prefix. */
   uint32_t                length;
-  /** XXX */
+  /** This field is the length of the data which required network conversion. */
   uint32_t                to_convert;
-  /** XXX */
+  /** This field is the requested timeout for this operation. */
   Watchdog_Interval       timeout;
 }   MP_packet_Prefix;