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

diff --git a/cpukit/score/inline/rtems/score/coresem.inl b/cpukit/score/inline/rtems/score/coresem.inl
index 4c39764e23..b2a6282b39 100644
--- a/cpukit/score/inline/rtems/score/coresem.inl
+++ b/cpukit/score/inline/rtems/score/coresem.inl
@@ -1,9 +1,12 @@
-/*  inline/coresem.inl
+/** 
+ *  @file coresem.inl
  *
  *  This include file contains all of the inlined routines associated
  *  with the CORE semaphore.
- *
- *  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,19 +19,21 @@
 #ifndef __INLINE_CORE_SEMAPHORE_inl
 #define __INLINE_CORE_SEMAPHORE_inl
 
+/**
+ *  @addtogroup ScoreSemaphore 
+ *  @{
+ */
+
 #include <rtems/score/thread.h>
 #include <rtems/score/threadq.h>
 
-/*PAGE
- *
- *  _CORE_semaphore_Is_priority
- *
- *  DESCRIPTION:
- *
+/**
  *  This function returns TRUE if the priority attribute is
  *  enabled in the attribute_set and FALSE otherwise.
+ *
+ *  @param the_attribute (in) is the attribute set to test
+ *  @return TRUE if the priority attribute is enabled
  */
-
 RTEMS_INLINE_ROUTINE boolean _CORE_semaphore_Is_priority(
   CORE_semaphore_Attributes *the_attribute
 )
@@ -36,36 +41,34 @@ RTEMS_INLINE_ROUTINE boolean _CORE_semaphore_Is_priority(
    return ( the_attribute->discipline == CORE_SEMAPHORE_DISCIPLINES_PRIORITY );
 }
 
-/*PAGE
- *
- *  _CORE_semaphore_Get_count
- *
- *  DESCRIPTION:
- *
+/**
  *  This routine returns the current count associated with the semaphore.
+ *
+ *  @param the_semaphore (in) is the semaphore to obtain the count of
+ *  @return the current count of this semaphore
  */
- 
-RTEMS_INLINE_ROUTINE uint32_t   _CORE_semaphore_Get_count(
+RTEMS_INLINE_ROUTINE uint32_t  _CORE_semaphore_Get_count(
   CORE_semaphore_Control  *the_semaphore
 )
 {
   return the_semaphore->count;
 }
 
-/*PAGE
- *
- *  _CORE_semaphore_Seize_isr_disable
- *
- *  DESCRIPTION:
- *
+/**
  *  This routine attempts to receive a unit from the_semaphore.
  *  If a unit is available or if the wait flag is FALSE, then the routine
  *  returns.  Otherwise, the calling task is blocked until a unit becomes
  *  available.
  *
- *  NOTE: There is currently no MACRO version of this routine.
+ *  @param the_semaphore (in) is the semaphore to obtain
+ *  @param id (in) is the Id of the owning API level Semaphore object
+ *  @param wait (in) is TRUE if the thread is willing to wait
+ *  @param timeout (in) is the maximum number of ticks to block
+ *  @param level_p (in) is a temporary variable used to contain the ISR
+ *         disable level cookie
+ *
+ *  @note There is currently no MACRO version of this routine.
  */
- 
 RTEMS_INLINE_ROUTINE void _CORE_semaphore_Seize_isr_disable(
   CORE_semaphore_Control  *the_semaphore,
   Objects_Id               id,
@@ -103,5 +106,7 @@ RTEMS_INLINE_ROUTINE void _CORE_semaphore_Seize_isr_disable(
   _Thread_Enable_dispatch();
 }
 
+/**@}*/
+
 #endif
 /* end of include file */