2004-11-01 Joel Sherrill <joel@oarcorp.com>

	* score/cpu/no_cpu/rtems/score/cpu.h, 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/copyrt.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/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/coremsg.inl,
	score/inline/rtems/score/coremutex.inl,
	score/inline/rtems/score/coresem.inl,
	score/inline/rtems/score/heap.inl, score/inline/rtems/score/isr.inl,
	score/inline/rtems/score/mppkt.inl,
	score/inline/rtems/score/objectmp.inl,
	score/inline/rtems/score/priority.inl,
	score/inline/rtems/score/stack.inl,
	score/inline/rtems/score/states.inl,
	score/inline/rtems/score/sysstate.inl,
	score/inline/rtems/score/thread.inl,
	score/inline/rtems/score/threadmp.inl,
	score/inline/rtems/score/tod.inl,
	score/inline/rtems/score/tqdata.inl,
	score/inline/rtems/score/userext.inl,
	score/inline/rtems/score/watchdog.inl,
	score/inline/rtems/score/wkspace.inl: Add Doxygen comments -- working
	modifications which are not complete and may have broken code.
	Committing so work and testing can proceed.
	* score/Doxyfile, score/mainpage.h: New files.

1 files changed, 36 insertions, 138 deletions

diff --git a/cpukit/score/inline/rtems/score/chain.inl b/cpukit/score/inline/rtems/score/chain.inl
index 8f9c68389d..a21841f413 100644
--- a/cpukit/score/inline/rtems/score/chain.inl
+++ b/cpukit/score/inline/rtems/score/chain.inl
@@ -1,13 +1,16 @@
-/*  inline/chain.inl
+/**
+ *  @file  chain.inl
  *
  *  This include file contains the bodies of the routines which are
  *  associated with doubly linked chains and inlined.
  *
- *  NOTE:  The routines in this file are ordered from simple
+ *  @note  The routines in this file are ordered from simple
  *         to complex.  No other Chain Handler routine is referenced
  *         unless it has already been defined.
- *
- *  COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ *  COPYRIGHT (c) 1989-2004.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
@@ -20,16 +23,15 @@
 #ifndef __INLINE_CHAIN_inl
 #define __INLINE_CHAIN_inl
 
-/*PAGE
- *
- *  _Chain_Are_nodes_equal
- *
- *  DESCRIPTION:
- *
- *  This function returns TRUE if LEFT and RIGHT are equal,
- *  and FALSE otherwise.
+/**
+ *  @addtogroup ScoreChain 
+ *  @{
  */
 
+/**
+ *  This function returns TRUE if \a left and \a right are equal,
+ *  and FALSE otherwise.
+ */
 RTEMS_INLINE_ROUTINE boolean _Chain_Are_nodes_equal(
   Chain_Node *left,
   Chain_Node *right
@@ -38,28 +40,16 @@ RTEMS_INLINE_ROUTINE boolean _Chain_Are_nodes_equal(
   return left == right;
 }
 
-/*PAGE
- *
- *  _Chain_Is_null
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the_chain is NULL and FALSE otherwise.
  */
-
 RTEMS_INLINE_ROUTINE boolean _Chain_Is_null(
   Chain_Control *the_chain
 )
 {
   return ( the_chain == NULL );
 }
-
-/*PAGE
- *
- *  _Chain_Is_null_node
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the_node is NULL and FALSE otherwise.
  */
 
@@ -70,15 +60,9 @@ RTEMS_INLINE_ROUTINE boolean _Chain_Is_null_node(
   return ( the_node == NULL );
 }
 
-/*PAGE
- *
- *  _Chain_Head
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns a pointer to the first node on the chain.
  */
-
 RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Head(
   Chain_Control *the_chain
 )
@@ -86,15 +70,9 @@ RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Head(
    return (Chain_Node *) the_chain;
 }
 
-/*PAGE
- *
- *  _Chain_Tail
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns a pointer to the last node on the chain.
  */
-
 RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Tail(
   Chain_Control *the_chain
 )
@@ -102,16 +80,10 @@ RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Tail(
    return (Chain_Node *) &the_chain->permanent_null;
 }
 
-/*PAGE
- *
- *  _Chain_Is_empty
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if there a no nodes on the_chain and
  *  FALSE otherwise.
  */
-
 RTEMS_INLINE_ROUTINE boolean _Chain_Is_empty(
   Chain_Control *the_chain
 )
@@ -119,16 +91,10 @@ RTEMS_INLINE_ROUTINE boolean _Chain_Is_empty(
   return ( the_chain->first == _Chain_Tail( the_chain ) );
 }
 
-/*PAGE
- *
- *  _Chain_Is_first
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the_node is the first node on a chain and
  *  FALSE otherwise.
  */
-
 RTEMS_INLINE_ROUTINE boolean _Chain_Is_first(
   Chain_Node *the_node
 )
@@ -136,16 +102,10 @@ RTEMS_INLINE_ROUTINE boolean _Chain_Is_first(
   return ( the_node->previous == NULL );
 }
 
-/*PAGE
- *
- *  _Chain_Is_last
- *
- *  DESCRIPTION:
- *
- *  This function returns TRUE if the_node is the last node on a chain and
+/**
+ *  This function returns TRUE if \a the_node is the last node on a chain and
  *  FALSE otherwise.
  */
-
 RTEMS_INLINE_ROUTINE boolean _Chain_Is_last(
   Chain_Node *the_node
 )
@@ -153,13 +113,8 @@ RTEMS_INLINE_ROUTINE boolean _Chain_Is_last(
   return ( the_node->next == NULL );
 }
 
-/*PAGE
- *
- *  _Chain_Has_only_one_node
- *
- *  DESCRIPTION:
- *
- *  This function returns TRUE if there is only one node on the_chain and
+/**
+ *  This function returns TRUE if there is only one node on \a the_chain and
  *  FALSE otherwise.
  */
 
@@ -170,16 +125,10 @@ RTEMS_INLINE_ROUTINE boolean _Chain_Has_only_one_node(
   return ( the_chain->first == the_chain->last );
 }
 
-/*PAGE
- *
- *  _Chain_Is_head
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the_node is the head of the_chain and
  *  FALSE otherwise.
  */
-
 RTEMS_INLINE_ROUTINE boolean _Chain_Is_head(
   Chain_Control *the_chain,
   Chain_Node    *the_node
@@ -188,16 +137,10 @@ RTEMS_INLINE_ROUTINE boolean _Chain_Is_head(
    return ( the_node == _Chain_Head( the_chain ) );
 }
 
-/*PAGE
- *
- *  _Chain_Is_tail
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the_node is the tail of the_chain and
  *  FALSE otherwise.
  */
-
 RTEMS_INLINE_ROUTINE boolean _Chain_Is_tail(
   Chain_Control *the_chain,
   Chain_Node    *the_node
@@ -206,12 +149,7 @@ RTEMS_INLINE_ROUTINE boolean _Chain_Is_tail(
    return ( the_node == _Chain_Tail( the_chain ) );
 }
 
-/*PAGE
- *
- *  Chain_Initialize_empty
- *
- *  DESCRIPTION:
- *
+/**
  *  This routine initializes the specified chain to contain zero nodes.
  */
 
@@ -224,17 +162,11 @@ RTEMS_INLINE_ROUTINE void _Chain_Initialize_empty(
   the_chain->last           = _Chain_Head( the_chain );
 }
 
-/*PAGE
- *
- *  _Chain_Extract_unprotected
- *
- *  DESCRIPTION:
- *
+/**
  *  This routine extracts the_node from the chain on which it resides.
  *  It does NOT disable interrupts to insure the atomicity of the
  *  extract operation.
  */
-
 RTEMS_INLINE_ROUTINE void _Chain_Extract_unprotected(
   Chain_Node *the_node
 )
@@ -248,17 +180,11 @@ RTEMS_INLINE_ROUTINE void _Chain_Extract_unprotected(
   previous->next = next;
 }
 
-/*PAGE
- *
- *  _Chain_Get_first_unprotected
- *
- *  DESCRIPTION:
- *
+/**
  *  This function removes the first node from the_chain and returns
  *  a pointer to that node.  It does NOT disable interrupts to insure
  *  the atomicity of the get operation.
  */
-
 RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Get_first_unprotected(
   Chain_Control *the_chain
 )
@@ -274,18 +200,12 @@ RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Get_first_unprotected(
   return return_node;
 }
 
-/*PAGE
- *
- *  Chain_Get_unprotected
- *
- *  DESCRIPTION:
- *
+/**
  *  This function removes the first node from the_chain and returns
  *  a pointer to that node.  If the_chain is empty, then NULL is returned.
  *  It does NOT disable interrupts to insure the atomicity of the
  *  get operation.
  */
-
 RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Get_unprotected(
   Chain_Control *the_chain
 )
@@ -296,12 +216,7 @@ RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Get_unprotected(
     return NULL;
 }
 
-/*PAGE
- *
- *  _Chain_Insert_unprotected
- *
- *  DESCRIPTION:
- *
+/**
  *  This routine inserts the_node on a chain immediately following
  *  after_node.  It does NOT disable interrupts to insure the atomicity
  *  of the extract operation.
@@ -321,17 +236,11 @@ RTEMS_INLINE_ROUTINE void _Chain_Insert_unprotected(
   before_node->previous = the_node;
 }
 
-/*PAGE
- *
- *  _Chain_Append_unprotected
- *
- *  DESCRIPTION:
- *
+/**
  *  This routine appends the_node onto the end of the_chain.
  *  It does NOT disable interrupts to insure the atomicity of the
  *  append operation.
  */
-
 RTEMS_INLINE_ROUTINE void _Chain_Append_unprotected(
   Chain_Control *the_chain,
   Chain_Node    *the_node
@@ -346,37 +255,24 @@ RTEMS_INLINE_ROUTINE void _Chain_Append_unprotected(
   the_node->previous  = old_last_node;
 }
 
-/*PAGE
- *
- *  _Chain_Prepend_unprotected
- *
- *  DESCRIPTION:
- *
+/**
  *  This routine prepends the_node onto the front of the_chain.
  *  It does NOT disable interrupts to insure the atomicity of the
  *  prepend operation.
  */
-
 RTEMS_INLINE_ROUTINE void _Chain_Prepend_unprotected(
   Chain_Control *the_chain,
   Chain_Node    *the_node
 )
 {
   _Chain_Insert_unprotected( _Chain_Head( the_chain ), the_node );
-
 }
 
-/*PAGE
- *
- *  _Chain_Prepend
- *
- *  DESCRIPTION:
- *
+/**
  *  This routine prepends the_node onto the front of the_chain.
  *  It disables interrupts to insure the atomicity of the
  *  prepend operation.
  */
-
 RTEMS_INLINE_ROUTINE void _Chain_Prepend(
   Chain_Control *the_chain,
   Chain_Node    *the_node
@@ -385,5 +281,7 @@ RTEMS_INLINE_ROUTINE void _Chain_Prepend(
   _Chain_Insert( _Chain_Head( the_chain ), the_node );
 }
 
+/**@}*/
+
 #endif
 /* end of include file */