2008-04-18 Joel Sherrill <joel.sherrill@oarcorp.com>

	* rtems/include/rtems.h, rtems/include/rtems/rtems/asr.h,
	rtems/include/rtems/rtems/attr.h,
	rtems/include/rtems/rtems/barrier.h,
	rtems/include/rtems/rtems/barriermp.h,
	rtems/include/rtems/rtems/cache.h, rtems/include/rtems/rtems/clock.h,
	rtems/include/rtems/rtems/config.h,
	rtems/include/rtems/rtems/dpmem.h, rtems/include/rtems/rtems/event.h,
	rtems/include/rtems/rtems/eventmp.h,
	rtems/include/rtems/rtems/eventset.h,
	rtems/include/rtems/rtems/intr.h,
	rtems/include/rtems/rtems/message.h,
	rtems/include/rtems/rtems/modes.h, rtems/include/rtems/rtems/mp.h,
	rtems/include/rtems/rtems/msgmp.h,
	rtems/include/rtems/rtems/object.h,
	rtems/include/rtems/rtems/options.h,
	rtems/include/rtems/rtems/part.h, rtems/include/rtems/rtems/partmp.h,
	rtems/include/rtems/rtems/ratemon.h,
	rtems/include/rtems/rtems/region.h,
	rtems/include/rtems/rtems/regionmp.h,
	rtems/include/rtems/rtems/rtemsapi.h,
	rtems/include/rtems/rtems/sem.h, rtems/include/rtems/rtems/semmp.h,
	rtems/include/rtems/rtems/signal.h,
	rtems/include/rtems/rtems/signalmp.h,
	rtems/include/rtems/rtems/status.h,
	rtems/include/rtems/rtems/support.h,
	rtems/include/rtems/rtems/taskmp.h,
	rtems/include/rtems/rtems/tasks.h, rtems/include/rtems/rtems/timer.h,
	rtems/include/rtems/rtems/types.h, rtems/inline/rtems/rtems/asr.inl,
	rtems/inline/rtems/rtems/attr.inl,
	rtems/inline/rtems/rtems/barrier.inl,
	rtems/inline/rtems/rtems/dpmem.inl,
	rtems/inline/rtems/rtems/event.inl,
	rtems/inline/rtems/rtems/eventset.inl,
	rtems/inline/rtems/rtems/message.inl,
	rtems/inline/rtems/rtems/modes.inl,
	rtems/inline/rtems/rtems/options.inl,
	rtems/inline/rtems/rtems/part.inl,
	rtems/inline/rtems/rtems/ratemon.inl,
	rtems/inline/rtems/rtems/region.inl,
	rtems/inline/rtems/rtems/sem.inl,
	rtems/inline/rtems/rtems/status.inl,
	rtems/inline/rtems/rtems/support.inl,
	rtems/inline/rtems/rtems/tasks.inl,
	rtems/inline/rtems/rtems/timer.inl: Initial conversion of Classic API
	header files to Doxygen.
	* rtems/Doxyfile: New file.

1 files changed, 25 insertions, 47 deletions

diff --git a/cpukit/rtems/inline/rtems/rtems/ratemon.inl b/cpukit/rtems/inline/rtems/rtems/ratemon.inl
index bae2940617..7f2d9703fd 100644
--- a/cpukit/rtems/inline/rtems/rtems/ratemon.inl
+++ b/cpukit/rtems/inline/rtems/rtems/ratemon.inl
@@ -1,12 +1,11 @@
 /**
  * @file rtems/rtems/ratemon.inl
- */
-
-/*
+ *
  *  This file contains the static inline  implementation of the inlined
  *  routines in the Rate Monotonic Manager.
- *
- *  COPYRIGHT (c) 1989-2007.
+ */
+
+/*  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
@@ -19,32 +18,29 @@
 #ifndef _RTEMS_RTEMS_RATEMON_INL
 #define _RTEMS_RTEMS_RATEMON_INL
 
-/*PAGE
- *
- *  _Rate_monotonic_Allocate
- *
- *  DESCRIPTION:
+/**
+ *  @addtogroup ClassicRateMon
+ *  @{
+ */
+
+/**
+ *  @brief Rate_monotonic_Allocate
  *
  *  This function allocates a period control block from
  *  the inactive chain of free period control blocks.
  */
-
 RTEMS_INLINE_ROUTINE Rate_monotonic_Control *_Rate_monotonic_Allocate( void )
 {
   return (Rate_monotonic_Control *)
     _Objects_Allocate( &_Rate_monotonic_Information );
 }
 
-/*PAGE
- *
- *  _Rate_monotonic_Free
- *
- *  DESCRIPTION:
+/**
+ *  @brief Rate_monotonic_Free
  *
  *  This routine allocates a period control block from
  *  the inactive chain of free period control blocks.
  */
-
 RTEMS_INLINE_ROUTINE void _Rate_monotonic_Free (
   Rate_monotonic_Control *the_period
 )
@@ -52,11 +48,8 @@ RTEMS_INLINE_ROUTINE void _Rate_monotonic_Free (
   _Objects_Free( &_Rate_monotonic_Information, &the_period->Object );
 }
 
-/*PAGE
- *
- *  _Rate_monotonic_Get
- *
- *  DESCRIPTION:
+/**
+ *  @brief Rate_monotonic_Get
  *
  *  This function maps period IDs to period control blocks.
  *  If ID corresponds to a local period, then it returns
@@ -64,7 +57,6 @@ RTEMS_INLINE_ROUTINE void _Rate_monotonic_Free (
  *  is set to OBJECTS_LOCAL.  Otherwise, location is set
  *  to OBJECTS_ERROR and the_period is undefined.
  */
-
 RTEMS_INLINE_ROUTINE Rate_monotonic_Control *_Rate_monotonic_Get (
   Objects_Id         id,
   Objects_Locations *location
@@ -74,16 +66,12 @@ RTEMS_INLINE_ROUTINE Rate_monotonic_Control *_Rate_monotonic_Get (
     _Objects_Get( &_Rate_monotonic_Information, id, location );
 }
 
-/*PAGE
- *
- *  _Rate_monotonic_Is_active
- *
- *  DESCRIPTION:
+/**
+ *  @brief Rate_monotonic_Is_active
  *
  *  This function returns TRUE if the_period is in the ACTIVE state,
  *  and FALSE otherwise.
  */
-
 RTEMS_INLINE_ROUTINE boolean _Rate_monotonic_Is_active (
   Rate_monotonic_Control *the_period
 )
@@ -91,16 +79,12 @@ RTEMS_INLINE_ROUTINE boolean _Rate_monotonic_Is_active (
   return (the_period->state == RATE_MONOTONIC_ACTIVE);
 }
 
-/*PAGE
- *
- *  _Rate_monotonic_Is_inactive
- *
- *  DESCRIPTION:
+/**
+ *  @brief Rate_monotonic_Is_inactive
  *
  *  This function returns TRUE if the_period is in the ACTIVE state,
  *  and FALSE otherwise.
  */
-
 RTEMS_INLINE_ROUTINE boolean _Rate_monotonic_Is_inactive (
   Rate_monotonic_Control *the_period
 )
@@ -108,16 +92,12 @@ RTEMS_INLINE_ROUTINE boolean _Rate_monotonic_Is_inactive (
   return (the_period->state == RATE_MONOTONIC_INACTIVE);
 }
 
-/*PAGE
- *
- *  _Rate_monotonic_Is_expired
- *
- *  DESCRIPTION:
+/**
+ *  @brief Rate_monotonic_Is_expired
  *
  *  This function returns TRUE if the_period is in the EXPIRED state,
  *  and FALSE otherwise.
  */
-
 RTEMS_INLINE_ROUTINE boolean _Rate_monotonic_Is_expired (
   Rate_monotonic_Control *the_period
 )
@@ -125,15 +105,11 @@ RTEMS_INLINE_ROUTINE boolean _Rate_monotonic_Is_expired (
   return (the_period->state == RATE_MONOTONIC_EXPIRED);
 }
 
-/*PAGE
- *
- *  _Rate_monotonic_Is_null
- *
- *  DESCRIPTION:
+/**
+ *  @brief Rate_monotonic_Is_null
  *
  *  This function returns TRUE if the_period is NULL and FALSE otherwise.
  */
-
 RTEMS_INLINE_ROUTINE boolean _Rate_monotonic_Is_null (
   Rate_monotonic_Control *the_period
 )
@@ -141,5 +117,7 @@ RTEMS_INLINE_ROUTINE boolean _Rate_monotonic_Is_null (
   return (the_period == NULL);
 }
 
+/**@}*/
+
 #endif
 /* end of include file */