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, 34 insertions, 130 deletions

diff --git a/cpukit/score/inline/rtems/score/states.inl b/cpukit/score/inline/rtems/score/states.inl
index 0122f74e7d..2701692f19 100644
--- a/cpukit/score/inline/rtems/score/states.inl
+++ b/cpukit/score/inline/rtems/score/states.inl
@@ -1,9 +1,12 @@
-/*  states.inl
+/** 
+ *  @file states.inl
  *
  *  This file contains the macro implementation of the inlined
  *  routines associated with thread state information.
- *
- *  COPYRIGHT (c) 1989-1999.
+ */
+
+/*
+ *  COPYRIGHT (c) 1989-2004.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
@@ -16,12 +19,12 @@
 #ifndef __STATES_inl
 #define __STATES_inl
 
-/*PAGE
- *
- *  _States_Set
- *
- *  DESCRIPTION:
- *
+/**
+ *  @addtogroup ScoreStates 
+ *  @{
+ */
+
+/**
  *  This function sets the given states_to_set into the current_state
  *  passed in.  The result is returned to the user in current_state.
  */
@@ -34,12 +37,7 @@ RTEMS_INLINE_ROUTINE States_Control _States_Set (
    return (current_state | states_to_set);
 }
 
-/*PAGE
- *
- *  _States_Clear
- *
- *  DESCRIPTION:
- *
+/**
  *  This function clears the given states_to_clear into the current_state
  *  passed in.  The result is returned to the user in current_state.
  */
@@ -52,12 +50,7 @@ RTEMS_INLINE_ROUTINE States_Control _States_Clear (
    return (current_state & ~states_to_clear);
 }
 
-/*PAGE
- *
- *  _States_Is_ready
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the_states indicates that the
  *  state is READY, and FALSE otherwise.
  */
@@ -69,12 +62,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_ready (
    return (the_states == STATES_READY);
 }
 
-/*PAGE
- *
- *  _States_Is_only_dormant
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the DORMANT state is the ONLY state
  *  set in the_states, and FALSE otherwise.
  */
@@ -86,12 +74,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_only_dormant (
    return (the_states == STATES_DORMANT);
 }
 
-/*PAGE
- *
- *  _States_Is_dormant
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the DORMANT state is set in
  *  the_states, and FALSE otherwise.
  */
@@ -103,12 +86,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_dormant (
    return (the_states & STATES_DORMANT);
 }
 
-/*PAGE
- *
- *  _States_Is_suspended
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the SUSPENDED state is set in
  *  the_states, and FALSE otherwise.
  */
@@ -120,12 +98,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_suspended (
    return (the_states & STATES_SUSPENDED);
 }
 
-/*PAGE
- *
- *  _States_Is_Transient
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the TRANSIENT state is set in
  *  the_states, and FALSE otherwise.
  */
@@ -137,12 +110,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_transient (
    return (the_states & STATES_TRANSIENT);
 }
 
-/*PAGE
- *
- *  _States_Is_delaying
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the DELAYING state is set in
  *  the_states, and FALSE otherwise.
  */
@@ -154,12 +122,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_delaying (
    return (the_states & STATES_DELAYING);
 }
 
-/*PAGE
- *
- *  _States_Is_waiting_for_buffer
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the WAITING_FOR_BUFFER state is set in
  *  the_states, and FALSE otherwise.
  */
@@ -171,12 +134,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_buffer (
    return (the_states & STATES_WAITING_FOR_BUFFER);
 }
 
-/*PAGE
- *
- *  _States_Is_waiting_for_segment
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the WAITING_FOR_SEGMENT state is set in
  *  the_states, and FALSE otherwise.
  */
@@ -188,12 +146,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_segment (
    return (the_states & STATES_WAITING_FOR_SEGMENT);
 }
 
-/*PAGE
- *
- *  _States_Is_waiting_for_message
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the WAITING_FOR_MESSAGE state is set in
  *  the_states, and FALSE otherwise.
  */
@@ -205,12 +158,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_message (
    return (the_states & STATES_WAITING_FOR_MESSAGE);
 }
 
-/*PAGE
- *
- *  _States_Is_waiting_for_event
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the WAITING_FOR_EVENT state is set in
  *  the_states, and FALSE otherwise.
  */
@@ -222,12 +170,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_event (
    return (the_states & STATES_WAITING_FOR_EVENT);
 }
 
-/*PAGE
- *
- *  _States_Is_waiting_for_mutex
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the WAITING_FOR_MUTEX state
  *  is set in the_states, and FALSE otherwise.
  */
@@ -239,12 +182,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_mutex (
    return (the_states & STATES_WAITING_FOR_MUTEX);
 }
 
-/*PAGE
- *
- *  _States_Is_waiting_for_semaphore
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the WAITING_FOR_SEMAPHORE state
  *  is set in the_states, and FALSE otherwise.
  */
@@ -256,12 +194,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_semaphore (
    return (the_states & STATES_WAITING_FOR_SEMAPHORE);
 }
 
-/*PAGE
- *
- *  _States_Is_waiting_for_time
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the WAITING_FOR_TIME state is set in
  *  the_states, and FALSE otherwise.
  */
@@ -273,12 +206,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_time (
    return (the_states & STATES_WAITING_FOR_TIME);
 }
 
-/*PAGE
- *
- *  _States_Is_waiting_for_rpc_reply
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the WAITING_FOR_TIME state is set in
  *  the_states, and FALSE otherwise.
  */
@@ -290,12 +218,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_rpc_reply (
    return (the_states & STATES_WAITING_FOR_RPC_REPLY);
 }
 
-/*PAGE
- *
- *  _States_Is_waiting_for_period
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the WAITING_FOR_PERIOD state is set in
  *  the_states, and FALSE otherwise.
  */
@@ -307,12 +230,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_for_period (
    return (the_states & STATES_WAITING_FOR_PERIOD);
 }
 
-/*PAGE
- *
- *  _States_Is_locally_blocked
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if one of the states which indicates
  *  that a task is blocked waiting for a local resource is set in
  *  the_states, and FALSE otherwise.
@@ -325,12 +243,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_locally_blocked (
    return (the_states & STATES_LOCALLY_BLOCKED);
 }
 
-/*PAGE
- *
- *  _States_Is_waiting_on_thread_queue
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if one of the states which indicates
  *  that a task is blocked waiting for a local resource is set in
  *  the_states, and FALSE otherwise.
@@ -343,12 +256,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_waiting_on_thread_queue (
    return (the_states & STATES_WAITING_ON_THREAD_QUEUE);
 }
 
-/*PAGE
- *
- *  _States_Is_blocked
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if one of the states which indicates
  *  that a task is blocked is set in the_states, and FALSE otherwise.
  */
@@ -360,13 +268,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Is_blocked (
    return (the_states & STATES_BLOCKED);
 }
 
-/*PAGE
- *
- *
- *  _States_Are_set
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if any of the states in the mask
  *  are set in the_states, and FALSE otherwise.
  */
@@ -379,5 +281,7 @@ RTEMS_INLINE_ROUTINE boolean _States_Are_set (
    return ( (the_states & mask) != STATES_READY);
 }
 
+/**@}*/
+
 #endif
 /* end of include file */