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, 29 insertions, 59 deletions

diff --git a/cpukit/rtems/inline/rtems/rtems/part.inl b/cpukit/rtems/inline/rtems/rtems/part.inl
index 1e8f3b2f8d..7674c48e18 100644
--- a/cpukit/rtems/inline/rtems/rtems/part.inl
+++ b/cpukit/rtems/inline/rtems/rtems/part.inl
@@ -1,12 +1,11 @@
 /**
  * @file rtems/rtems/part.inl
- */
-
-/*
+ *
  *  This file contains the macro implementation of all inlined routines
  *  in the Partition Manager.
- *
- *  COPYRIGHT (c) 1989-1999.
+ */
+
+/*  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
@@ -19,17 +18,18 @@
 #ifndef _RTEMS_RTEMS_PART_INL
 #define _RTEMS_RTEMS_PART_INL
 
-/*PAGE
- *
- *  _Partition_Allocate_buffer
- *
- *  DESCRIPTION:
+/**
+ *  @addtogroup ClassicPart
+ *  @{
+ */
+
+/**
+ *  @brief Partition_Allocate_buffer
  *
  *  This function attempts to allocate a buffer from the_partition.
  *  If successful, it returns the address of the allocated buffer.
  *  Otherwise, it returns NULL.
  */
-
 RTEMS_INLINE_ROUTINE void *_Partition_Allocate_buffer (
    Partition_Control *the_partition
 )
@@ -37,15 +37,11 @@ RTEMS_INLINE_ROUTINE void *_Partition_Allocate_buffer (
   return _Chain_Get( &the_partition->Memory );
 }
 
-/*PAGE
- *
- *  _Partition_Free_buffer
- *
- *  DESCRIPTION:
+/**
+ *  @brief Partition_Free_buffer
  *
  *  This routine frees the_buffer to the_partition.
  */
-
 RTEMS_INLINE_ROUTINE void _Partition_Free_buffer (
   Partition_Control *the_partition,
   Chain_Node        *the_buffer
@@ -54,16 +50,12 @@ RTEMS_INLINE_ROUTINE void _Partition_Free_buffer (
   _Chain_Append( &the_partition->Memory, the_buffer );
 }
 
-/*PAGE
- *
- *  _Partition_Is_buffer_on_boundary
- *
- *  DESCRIPTION:
+/**
+ *  @brief Partition_Is_buffer_on_boundary
  *
  *  This function returns TRUE if the_buffer is on a valid buffer
  *  boundary for the_partition, and FALSE otherwise.
  */
-
 RTEMS_INLINE_ROUTINE boolean _Partition_Is_buffer_on_boundary (
   void              *the_buffer,
   Partition_Control *the_partition
@@ -79,16 +71,12 @@ RTEMS_INLINE_ROUTINE boolean _Partition_Is_buffer_on_boundary (
   return ((offset % the_partition->buffer_size) == 0);
 }
 
-/*PAGE
- *
- *  _Partition_Is_buffer_valid
- *
- *  DESCRIPTION:
+/**
+ *  @brief Partition_Is_buffer_valid
  *
  *  This function returns TRUE if the_buffer is a valid buffer from
  *  the_partition, otherwise FALSE is returned.
  */
-
 RTEMS_INLINE_ROUTINE boolean _Partition_Is_buffer_valid (
    Chain_Node        *the_buffer,
    Partition_Control *the_partition
@@ -106,17 +94,13 @@ RTEMS_INLINE_ROUTINE boolean _Partition_Is_buffer_valid (
   );
 }
 
-/*PAGE
- *
- *  _Partition_Is_buffer_size_aligned
- *
- *  DESCRIPTION:
+/**
+ *  @brief Partition_Is_buffer_size_aligned
  *
  *  This function returns TRUE if the use of the specified buffer_size
  *  will result in the allocation of buffers whose first byte is
  *  properly aligned, and FALSE otherwise.
  */
-
 RTEMS_INLINE_ROUTINE boolean _Partition_Is_buffer_size_aligned (
    uint32_t   buffer_size
 )
@@ -124,31 +108,23 @@ RTEMS_INLINE_ROUTINE boolean _Partition_Is_buffer_size_aligned (
   return ((buffer_size % CPU_PARTITION_ALIGNMENT) == 0);
 }
 
-/*PAGE
- *
- *  _Partition_Allocate
- *
- *  DESCRIPTION:
+/**
+ *  @brief Partition_Allocate
  *
  *  This function allocates a partition control block from
  *  the inactive chain of free partition control blocks.
  */
-
 RTEMS_INLINE_ROUTINE Partition_Control *_Partition_Allocate ( void )
 {
   return (Partition_Control *) _Objects_Allocate( &_Partition_Information );
 }
 
-/*PAGE
- *
- *  _Partition_Free
- *
- *  DESCRIPTION:
+/**
+ *  @brief Partition_Free
  *
  *  This routine frees a partition control block to the
  *  inactive chain of free partition control blocks.
  */
-
 RTEMS_INLINE_ROUTINE void _Partition_Free (
    Partition_Control *the_partition
 )
@@ -156,11 +132,8 @@ RTEMS_INLINE_ROUTINE void _Partition_Free (
   _Objects_Free( &_Partition_Information, &the_partition->Object );
 }
 
-/*PAGE
- *
- *  _Partition_Get
- *
- *  DESCRIPTION:
+/**
+ *  @brief Partition_Get
  *
  *  This function maps partition IDs to partition control blocks.
  *  If ID corresponds to a local partition, then it returns
@@ -170,7 +143,6 @@ RTEMS_INLINE_ROUTINE void _Partition_Free (
  *  and the_partition is undefined.  Otherwise, location is set
  *  to OBJECTS_ERROR and the_partition is undefined.
  */
-
 RTEMS_INLINE_ROUTINE Partition_Control *_Partition_Get (
   Objects_Id         id,
   Objects_Locations *location
@@ -180,16 +152,12 @@ RTEMS_INLINE_ROUTINE Partition_Control *_Partition_Get (
     _Objects_Get( &_Partition_Information, id, location );
 }
 
-/*PAGE
- *
- *  _Partition_Is_null
- *
- *  DESCRIPTION:
+/**
+ *  @brief Partition_Is_null
  *
  *  This function returns TRUE if the_partition is NULL
  *  and FALSE otherwise.
  */
-
 RTEMS_INLINE_ROUTINE boolean _Partition_Is_null (
    Partition_Control *the_partition
 )
@@ -197,5 +165,7 @@ RTEMS_INLINE_ROUTINE boolean _Partition_Is_null (
    return ( the_partition == NULL  );
 }
 
+/**@}*/
+
 #endif
 /* end of include file */