From 067a96ad0c3b0818d71d9aaadaee4b520d940de1 Mon Sep 17 00:00:00 2001
From: Joel Sherrill <joel.sherrill@OARcorp.com>
Date: Fri, 18 Apr 2008 15:02:20 +0000
Subject: 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.
---
 cpukit/rtems/inline/rtems/rtems/tasks.inl | 48 ++++++++++++-------------------
 1 file changed, 19 insertions(+), 29 deletions(-)

(limited to 'cpukit/rtems/inline/rtems/rtems/tasks.inl')

diff --git a/cpukit/rtems/inline/rtems/rtems/tasks.inl b/cpukit/rtems/inline/rtems/rtems/tasks.inl
index 143662c609..4b705c2e24 100644
--- a/cpukit/rtems/inline/rtems/rtems/tasks.inl
+++ b/cpukit/rtems/inline/rtems/rtems/tasks.inl
@@ -1,12 +1,11 @@
 /**
  * @file rtems/rtems/tasks.inl
- */
-
-/*
+ *
  *  This file contains the static inline implementation of all inlined
  *  routines in the with RTEMS Tasks Manager.
- *
- *  COPYRIGHT (c) 1989-2008.
+ */
+
+/*  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
@@ -19,31 +18,28 @@
 #ifndef _RTEMS_RTEMS_TASKS_INL
 #define _RTEMS_RTEMS_TASKS_INL
 
-/*PAGE
- *
- *  _RTEMS_tasks_Allocate
- *
- *  DESCRIPTION:
+/**
+ *  @addtogroup ClassicTasks
+ *  @{
+ */
+
+/**
+ *  @brief RTEMS_tasks_Allocate
  *
  *  This function allocates a task control block from
  *  the inactive chain of free task control blocks.
  */
-
 RTEMS_INLINE_ROUTINE Thread_Control *_RTEMS_tasks_Allocate( void )
 {
   return (Thread_Control *) _Objects_Allocate( &_RTEMS_tasks_Information );
 }
 
-/*PAGE
- *
- *  _RTEMS_tasks_Free
- *
- *  DESCRIPTION:
+/**
+ *  @brief RTEMS_tasks_Free
  *
  *  This routine frees a task control block to the
  *  inactive chain of free task control blocks.
  */
-
 RTEMS_INLINE_ROUTINE void _RTEMS_tasks_Free (
   Thread_Control *the_task
 )
@@ -54,15 +50,11 @@ RTEMS_INLINE_ROUTINE void _RTEMS_tasks_Free (
   );
 }
 
-/*PAGE
- *
- *  _RTEMS_tasks_Priority_to_Core
- *
- *  DESCRIPTION:
+/**
+ *  @brief RTEMS_tasks_Priority_to_Core
  *
  *  This function converts an RTEMS API priority into a core priority.
  */
- 
 RTEMS_INLINE_ROUTINE Priority_Control _RTEMS_tasks_Priority_to_Core(
   rtems_task_priority   priority
 )
@@ -70,16 +62,12 @@ RTEMS_INLINE_ROUTINE Priority_Control _RTEMS_tasks_Priority_to_Core(
   return (Priority_Control) priority;
 }
 
-/*PAGE
- *
- *  _RTEMS_tasks_Priority_is_valid
- *
- *  DESCRIPTION:
+/**
+ *  @brief RTEMS_tasks_Priority_is_valid
  *
  *  This function returns TRUE if the_priority is a valid user task priority
  *  and FALSE otherwise.
  */
- 
 RTEMS_INLINE_ROUTINE boolean _RTEMS_tasks_Priority_is_valid (
   rtems_task_priority the_priority
 )
@@ -88,5 +76,7 @@ RTEMS_INLINE_ROUTINE boolean _RTEMS_tasks_Priority_is_valid (
             ( the_priority <= RTEMS_MAXIMUM_PRIORITY ) );
 }
 
+/**@}*/
+
 #endif
 /* end of include file */
-- 
cgit v1.2.3