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, 123 insertions, 162 deletions

diff --git a/cpukit/rtems/include/rtems/rtems/tasks.h b/cpukit/rtems/include/rtems/rtems/tasks.h
index af579f87b5..bf30b32d7b 100644
--- a/cpukit/rtems/include/rtems/rtems/tasks.h
+++ b/cpukit/rtems/include/rtems/rtems/tasks.h
@@ -1,29 +1,28 @@
 /**
  * @file rtems/rtems/tasks.h
- */
-
-/*
+ *
  *  This include file contains all constants and structures associated
  *  with RTEMS tasks.  This manager provides a comprehensive set of directives
  *  to create, delete, and administer tasks.
  *
  *  Directives provided are:
  *
- *     + create a task
- *     + get an ID of a task
- *     + start a task
- *     + restart a task
- *     + delete a task
- *     + suspend a task
- *     + resume a task
- *     + set a task's priority
- *     + change the current task's mode
- *     + get a task notepad entry
- *     + set a task notepad entry
- *     + wake up after interval
- *     + wake up when specified
- *
- *  COPYRIGHT (c) 1989-2007.
+ *     - create a task
+ *     - get an ID of a task
+ *     - start a task
+ *     - restart a task
+ *     - delete a task
+ *     - suspend a task
+ *     - resume a task
+ *     - set a task's priority
+ *     - change the current task's mode
+ *     - get a task notepad entry
+ *     - set a task notepad entry
+ *     - wake up after interval
+ *     - wake up when specified
+ */
+
+/*  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
@@ -36,14 +35,6 @@
 #ifndef _RTEMS_RTEMS_TASKS_H
 #define _RTEMS_RTEMS_TASKS_H
 
-#ifndef RTEMS_TASKS_EXTERN
-#define RTEMS_TASKS_EXTERN extern
-#endif
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
 #include <rtems/score/object.h>
 #include <rtems/score/states.h>
 #include <rtems/score/thread.h>
@@ -53,23 +44,35 @@ extern "C" {
 #include <rtems/rtems/attr.h>
 #include <rtems/rtems/status.h>
 
-/*
- *  Constant to be used as the ID of current task
+#ifndef RTEMS_TASKS_EXTERN
+#define RTEMS_TASKS_EXTERN extern
+#endif
+
+/**
+ *  @defgroup ClassicTasks Classic API Tasks
+ *
+ *  This encapsulates functionality which X XX
  */
+/**@{*/
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ *  Constant to be used as the ID of current task
+ */
 #define RTEMS_SELF                OBJECTS_ID_OF_SELF
 
-/*
+/**
  *  This constant is passed to the rtems_task_wake_after directive as the
  *  interval when a task wishes to yield the CPU.
  */
-
 #define RTEMS_YIELD_PROCESSOR WATCHDOG_NO_TIMEOUT
 
-/*
+/**
  *  Define the type for an RTEMS API task priority.
  */
-
 typedef Priority_Control rtems_task_priority;
 
 #define RTEMS_NO_PRIORITY           RTEMS_CURRENT_PRIORITY
@@ -77,71 +80,79 @@ typedef Priority_Control rtems_task_priority;
 #define RTEMS_MINIMUM_PRIORITY      (PRIORITY_MINIMUM + 1)
 #define RTEMS_MAXIMUM_PRIORITY      PRIORITY_MAXIMUM
 
-/*
+/**
  *  The following constant is passed to rtems_task_set_priority when the
  *  caller wants to obtain the current priority.
  */
-
 #define RTEMS_CURRENT_PRIORITY      PRIORITY_MINIMUM
 
-/*
- *  Notepads constants (indices into notepad array)
- */
-
-#define RTEMS_NOTEPAD_FIRST 0             /* lowest numbered notepad */
-#define RTEMS_NOTEPAD_0    0              /* notepad location 0  */
-#define RTEMS_NOTEPAD_1    1              /* notepad location 1  */
-#define RTEMS_NOTEPAD_2    2              /* notepad location 2  */
-#define RTEMS_NOTEPAD_3    3              /* notepad location 3  */
-#define RTEMS_NOTEPAD_4    4              /* notepad location 4  */
-#define RTEMS_NOTEPAD_5    5              /* notepad location 5  */
-#define RTEMS_NOTEPAD_6    6              /* notepad location 6  */
-#define RTEMS_NOTEPAD_7    7              /* notepad location 7  */
-#define RTEMS_NOTEPAD_8    8              /* notepad location 8  */
-#define RTEMS_NOTEPAD_9    9              /* notepad location 9  */
-#define RTEMS_NOTEPAD_10   10             /* notepad location 10 */
-#define RTEMS_NOTEPAD_11   11             /* notepad location 11 */
-#define RTEMS_NOTEPAD_12   12             /* notepad location 12 */
-#define RTEMS_NOTEPAD_13   13             /* notepad location 13 */
-#define RTEMS_NOTEPAD_14   14             /* notepad location 14 */
-#define RTEMS_NOTEPAD_15   15             /* notepad location 15 */
-#define RTEMS_NOTEPAD_LAST RTEMS_NOTEPAD_15     /* highest numbered notepad */
+/** This is used to indicate the lowest numbered notepad */
+#define RTEMS_NOTEPAD_FIRST 0
+/** This is used to indicate the notepad location 0. */
+#define RTEMS_NOTEPAD_0    0
+/** This is used to indicate the notepad location 1. */
+#define RTEMS_NOTEPAD_1    1
+/** This is used to indicate the notepad location 2. */
+#define RTEMS_NOTEPAD_2    2
+/** This is used to indicate the notepad location 3. */
+#define RTEMS_NOTEPAD_3    3
+/** This is used to indicate the notepad location 4. */
+#define RTEMS_NOTEPAD_4    4
+/** This is used to indicate the notepad location 5. */
+#define RTEMS_NOTEPAD_5    5
+/** This is used to indicate the notepad location 6. */
+#define RTEMS_NOTEPAD_6    6
+/** This is used to indicate the notepad location 7. */
+#define RTEMS_NOTEPAD_7    7
+/** This is used to indicate the notepad location 8. */
+#define RTEMS_NOTEPAD_8    8
+/** This is used to indicate the notepad location 9. */
+#define RTEMS_NOTEPAD_9    9
+/** This is used to indicate the notepad location 10. */
+#define RTEMS_NOTEPAD_10   10
+/** This is used to indicate the notepad location 11. */
+#define RTEMS_NOTEPAD_11   11
+/** This is used to indicate the notepad location 12. */
+#define RTEMS_NOTEPAD_12   12
+/** This is used to indicate the notepad location 13. */
+#define RTEMS_NOTEPAD_13   13
+/** This is used to indicate the notepad location 14. */
+#define RTEMS_NOTEPAD_14   14
+/** This is used to indicate the notepad location 15. */
+#define RTEMS_NOTEPAD_15   15
+/** This is used to indicate the highest numbered notepad. */
+#define RTEMS_NOTEPAD_LAST RTEMS_NOTEPAD_15
 
 #define RTEMS_NUMBER_NOTEPADS  (RTEMS_NOTEPAD_LAST+1)
 
-/*
+/**
  *  External API name for Thread_Control
  */
-
 typedef Thread_Control rtems_tcb;
 
-/*
+/**
  *  The following defines the "return type" of an RTEMS task.
  */
-
 typedef void rtems_task;
 
-/*
+/**
  *  The following defines the argument to an RTEMS task.
  */
-
 typedef uintptr_t   rtems_task_argument;
 
-/*
+/**
  *  The following defines the type for the entry point of an RTEMS task.
  */
-
 typedef rtems_task ( *rtems_task_entry )(
                       rtems_task_argument
                    );
 
-/*
+/**
  *  The following records define the Initialization Tasks Table.
  *  Each entry contains the information required by RTEMS to
  *  create and start a user task automatically at executive
  *  initialization time.
  */
-
 typedef struct {
   rtems_name            name;              /* task name */
   size_t                stack_size;        /* task stack size */
@@ -152,12 +163,10 @@ typedef struct {
   rtems_task_argument	argument;          /* task argument */
 } rtems_initialization_tasks_table;
 
-/*
+/**
  *  This is the API specific information required by each thread for
  *  the RTEMS API to function correctly.
  */
-
-
 typedef struct {
   uint32_t                 Notepads[ RTEMS_NUMBER_NOTEPADS ];
   rtems_event_set          pending_events;
@@ -169,25 +178,19 @@ typedef struct {
  *  The following defines the information control block used to
  *  manage this class of objects.
  */
-
 RTEMS_TASKS_EXTERN Objects_Information _RTEMS_tasks_Information;
 
-/*
- *  _RTEMS_tasks_Manager_initialization
- *
- *  DESCRIPTION:
+/**
+ *  @brief _RTEMS_tasks_Manager_initialization
  *
  *  This routine initializes all Task Manager related data structures.
  */
-
 void _RTEMS_tasks_Manager_initialization(
   uint32_t     maximum_tasks
 );
 
-/*
- *  rtems_task_create
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_task_create
  *
  *  This routine implements the rtems_task_create directive.  The task
  *  will have the name name.  The attribute_set can be used to indicate
@@ -196,7 +199,6 @@ void _RTEMS_tasks_Manager_initialization(
  *  execution with initial_priority and initial_modes.  It returns the
  *  id of the created task in ID.
  */
-
 rtems_status_code rtems_task_create(
   rtems_name           name,
   rtems_task_priority  initial_priority,
@@ -206,10 +208,8 @@ rtems_status_code rtems_task_create(
   Objects_Id          *id
 );
 
-/*
- *  rtems_task_ident
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_task_ident
  *
  *  This routine implements the rtems_task_ident directive.
  *  This directive returns the task ID associated with name.
@@ -219,233 +219,194 @@ rtems_status_code rtems_task_create(
  *  The search can be limited to a particular node or allowed to
  *  encompass all nodes.
  */
-
 rtems_status_code rtems_task_ident(
   rtems_name    name,
   uint32_t      node,
   Objects_Id   *id
 );
 
-/*
- *  rtems_task_delete
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_task_delete
  *
  *  This routine implements the rtems_task_delete directive.  The
  *  task indicated by ID is deleted.
  */
-
 rtems_status_code rtems_task_delete(
   Objects_Id id
 );
 
-/*
- *  rtems_task_get_note
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_task_get_note
  *
  *  This routine implements the rtems_task_get_note directive.  The
  *  value of the indicated notepad for the task associated with ID
  *  is returned in note.
  */
-
 rtems_status_code rtems_task_get_note(
   Objects_Id  id,
   uint32_t    notepad,
   uint32_t   *note
 );
 
-/*
- *  rtems_task_set_note
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_task_set_note
  *
  *  This routine implements the rtems_task_set_note directive.  The
  *  value of the indicated notepad for the task associated with ID
  *  is returned in note.
  */
-
 rtems_status_code rtems_task_set_note(
   Objects_Id id,
   uint32_t   notepad,
   uint32_t   note
 );
 
-/*
- *  rtems_task_mode
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_task_mode
  *
  *  This routine implements the rtems_task_mode directive.  The current
  *  values of the modes indicated by mask of the calling task are changed
  *  to that indicated in mode_set.  The former mode of the task is
  *  returned in mode_set.
  */
-
 rtems_status_code rtems_task_mode(
   rtems_mode  mode_set,
   rtems_mode  mask,
   rtems_mode *previous_mode_set
 );
 
-/*
- *  rtems_task_restart
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_task_restart
  *
  *  This routine implements the rtems_task_restart directive.  The
  *  task associated with ID is restarted at its initial entry
  *  point with the new argument.
  */
-
 rtems_status_code rtems_task_restart(
   Objects_Id id,
   uint32_t   arg
 );
 
-/*
- *  rtems_task_suspend
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_task_suspend
  *
  *  This routine implements the rtems_task_suspend directive.  The
  *  SUSPENDED state is set for task associated with ID.
  */
-
 rtems_status_code rtems_task_suspend(
   Objects_Id id
 );
 
-/*
- *  rtems_task_resume
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_task_resume
  *
  *  This routine implements the rtems_task_resume Directive.  The
  *  SUSPENDED state is cleared for task associated with ID.
  */
-
 rtems_status_code rtems_task_resume(
   Objects_Id id
 );
 
-/*
- *  rtems_task_set_priority
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_task_set_priority
  *
  *  This routine implements the rtems_task_set_priority directive.  The
  *  current priority of the task associated with ID is set to
  *  new_priority.  The former priority of that task is returned
  *  in old_priority.
  */
-
 rtems_status_code rtems_task_set_priority(
   Objects_Id           id,
   rtems_task_priority  new_priority,
   rtems_task_priority *old_priority
 );
 
-/*
- *  rtems_task_start
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_task_start
  *
  *  This routine implements the rtems_task_start directive.  The
  *  starting execution point of the task associated with ID is
  *  set to entry_point with the initial argument.
  */
-
 rtems_status_code rtems_task_start(
   Objects_Id   id,
   rtems_task_entry entry_point,
   rtems_task_argument     argument
 );
 
-/*
- *  rtems_task_wake_when
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_task_wake_when
  *
  *  This routine implements the rtems_task_wake_when directive.  The
  *  calling task is blocked until the current time of day is
  *  equal to that indicated by time_buffer.
  */
-
 rtems_status_code rtems_task_wake_when(
   rtems_time_of_day *time_buffer
 );
 
-/*
- *  rtems_task_wake_after
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_task_wake_after
  *
  *  This routine implements the rtems_task_wake_after directive.  The
  *  calling task is blocked until the indicated number of clock
  *  ticks have occurred.
  */
-
 rtems_status_code rtems_task_wake_after(
   rtems_interval  ticks
 );
 
-/*
- *  rtems_task_is_suspended
- *
+/**
+ *  @brief rtems_task_is_suspended
+ 
  *  This directive returns a status indicating whether or not
  *  the specified task is suspended.
  */
-
 rtems_status_code rtems_task_is_suspended(
   Objects_Id id
 );
 
-/*
- *  rtems_task_variable_add
+/**
+ *  @brief rtems_task_variable_add
  *
  *  This directive adds a per task variable.
  */
-
 rtems_status_code rtems_task_variable_add(
   rtems_id  tid,
   void    **ptr,
   void    (*dtor)(void *)
 );
 
-/*
- *  rtems_task_variable_get
+/**
+ *  @brief rtems_task_variable_get
  *
  *  This directive gets the value of a task variable.
  */
-
 rtems_status_code rtems_task_variable_get(
   rtems_id tid,
   void **ptr,
   void **result
 );
 
-/*
- *  rtems_task_variable_delete
+/**
+ *  @brief rtems_task_variable_delete
  *
  *  This directive removes a per task variable.
  */
-
 rtems_status_code rtems_task_variable_delete(
   rtems_id  tid,
   void    **ptr
 );
 
-/*
- *  rtems_task_self
+/**
+ *  @brief rtems_task_self
  *
  *  This directive returns the ID of the currently executing task.
  */
-
 rtems_id rtems_task_self(void);
 
-/*
- *  _RTEMS_tasks_Initialize_user_tasks
+/**
+ *  @brief _RTEMS_tasks_Initialize_user_tasks
  *
  *  This routine creates and starts all configured user
  *  initialzation threads.
@@ -454,11 +415,10 @@ rtems_id rtems_task_self(void);
  *
  *  Output parameters:  NONE
  */
-
 void _RTEMS_tasks_Initialize_user_tasks( void );
 
-/*
- *  _RTEMS_Tasks_Invoke_task_variable_dtor(
+/**
+ *  @brief _RTEMS_Tasks_Invoke_task_variable_dtor(
  *
  *  This routine invokes the optional user provided destructor on the
  *  task variable and frees the memory for the task variable.
@@ -467,7 +427,6 @@ void _RTEMS_tasks_Initialize_user_tasks( void );
  *
  *  Output parameters:  NONE
  */
-
 void _RTEMS_Tasks_Invoke_task_variable_dtor(
   Thread_Control        *the_thread,
   rtems_task_variable_t *tvp
@@ -484,5 +443,7 @@ void _RTEMS_Tasks_Invoke_task_variable_dtor(
 }
 #endif
 
+/**@}*/
+
 #endif
 /* end of include file */