misc rtems: Clean up Doxygen GCI Task #8

http://www.google-melange.com/gci/task/view/google/gci2012/8024203

cpukit/rtems/include/rtems/rtems/barrier.h

@@ -34,6 +34,10 @@
 /**@{*/
 
 /**
+ *  @brief Instantiate Barrier Data
+ *
+ *  Barrier Manager -- Instantiate Data
+ *
  *  This constant is defined to extern most of the time when using
  *  this header file.  However by defining it to nothing, the data
  *  declared in this header file can be instantiated.  This is done
@@ -80,7 +84,9 @@ RTEMS_BARRIER_EXTERN Objects_Information  _Barrier_Information;
 void _Barrier_Manager_initialization(void);
 
 /**
- *  @brief rtems_barrier_create
+ *  @brief RTEMS Create Barrier
+ *
+ *  Barrier Manager -- Create a Barrier Instance
  *
  *  This routine implements the rtems_barrier_create directive.  The
  *  barrier will have the name name.  The starting count for
@@ -160,7 +166,9 @@ rtems_status_code rtems_barrier_wait(
 );
 
 /**
- *  @brief rtems_barrier_release
+ *  @brief RTEMS Barrier Release
+ *
+ *  Barrier Manager -- Release Tasks Waitng at a Barrier
  *
  *  This routine implements the rtems_barrier_release directive.  It
  *  unblocks all of the threads waiting on the barrier associated with

cpukit/rtems/include/rtems/rtems/event.h

@@ -438,7 +438,12 @@ typedef struct {
 /**
  *  @brief Event Manager Initialization
  *
+ *  Event Manager
+ *
  *  This routine performs the initialization necessary for this manager.
+ *
+ *  - INTERRUPT LATENCY:
+ *    + single case
  */
 void _Event_Manager_initialization( void );
 

cpukit/rtems/include/rtems/rtems/eventset.h

@@ -109,6 +109,9 @@ typedef uint32_t   rtems_event_set;
 
 /**
  *  @brief Constant used to receive the set of currently pending events in
+ *
+ *  Event Manager
+ *
  *  rtems_event_receive().
  *
  *  @ingroup ClassicEvent

cpukit/rtems/include/rtems/rtems/message.h

@@ -280,7 +280,9 @@ rtems_status_code rtems_message_queue_flush(
 );
 
 /**
- *  @brief rtems_message_queue_get_number_pending
+ *  @brief RTEMS Message Queue Get Number Pending
+ *
+ *  Message Queue Manager
  *
  *  This routine implements the rtems_message_queue_get_number_pending
  *  directive.  This directive returns the number of pending

cpukit/rtems/include/rtems/rtems/object.h

@@ -154,6 +154,8 @@ rtems_status_code rtems_object_set_name(
 /**
  *  @brief Get API Portion of Object Id
  *
+ *  RTEMS Object Helper -- Extract API From Id
+ *
  *  This function returns the API portion of the Id.
  *
  *  @param[in] _id is the Id of the object to obtain the API from

cpukit/rtems/include/rtems/rtems/part.h

@@ -93,7 +93,9 @@ RTEMS_PART_EXTERN Objects_Information _Partition_Information;
 void _Partition_Manager_initialization(void);
 
 /**
- *  @brief rtems_partition_create
+ *  @brief RTEMS Partition Create
+ *
+ *  Partition Manager
  *
  *  This routine implements the rtems_partition_create directive.  The
  *  partition will have the name name.  The memory area managed by

cpukit/rtems/include/rtems/rtems/ratemon.h

@@ -277,7 +277,9 @@ RTEMS_RATEMON_EXTERN Objects_Information _Rate_monotonic_Information;
 void _Rate_monotonic_Manager_initialization(void);
 
 /**
- *  @brief rtems_rate_monotonic_create
+ *  @brief Create a Period
+ *
+ *  Rate Monotonic Manager
  *
  *  This routine implements the rate_monotonic_create directive.  The
  *  period will have the name name.  It returns the id of the
@@ -377,7 +379,9 @@ rtems_status_code rtems_rate_monotonic_get_statistics(
 );
 
 /**
- *  @brief rtems_rate_monotonic_reset_statistics
+ *  @brief RTEMS Rate Monotonic Reset Statistics
+ *
+ *  Rate Monotonic Manager -- Reset Statistics
  *
  *  This routine allows a thread to reset the statistics information
  *  on a specific period instance.

cpukit/rtems/include/rtems/rtems/sem.h

@@ -200,7 +200,9 @@ rtems_status_code rtems_semaphore_obtain(
 );
 
 /**
- *  @brief rtems_semaphore_release
+ *  @brief RTEMS Semaphore Release
+ *
+ *  Semaphore Manager
  *
  *  This routine implements the rtems_semaphore_release directive.  It
  *  frees a unit to the semaphore associated with ID.  If a task was

cpukit/rtems/include/rtems/rtems/signal.h

@@ -41,7 +41,9 @@
 extern "C" {
 #endif
 /**
- *  @brief _Signal_Manager_initialization
+ *  @brief Signal Manager Initialization
+ *
+ *  Signal Manager
  *
  *  This routine performs the initialization necessary for this manager.
  */

cpukit/rtems/include/rtems/rtems/taskmp.h

@@ -68,7 +68,9 @@ typedef struct {
 }   RTEMS_tasks_MP_Packet;
 
 /**
- *  @brief _RTEMS_tasks_MP_Send_process_packet
+ *  @brief RTEMS Tasks MP Send Process Packet
+ *
+ *  Multiprocessing Support for the RTEMS Task Manager
  *
  *  This routine performs a remote procedure call so that a
  *  process operation can be performed on another node.

cpukit/rtems/include/rtems/rtems/tasks.h

@@ -454,7 +454,9 @@ rtems_status_code rtems_task_set_priority(
 );
 
 /**
- *  @brief rtems_task_start
+ *  @brief RTEMS Start Task
+ *
+ *  RTEMS Task Manager
  *
  *  This routine implements the rtems_task_start directive.  The
  *  starting execution point of the task associated with ID is
@@ -519,7 +521,9 @@ rtems_status_code rtems_task_variable_add(
 );
 
 /**
- *  @brief rtems_task_variable_get
+ *  @brief Get a per-task variable
+ *
+ *  RTEMS Task Variable Get
  *
  *  This directive gets the value of a task variable.
  */

cpukit/rtems/include/rtems/rtems/timer.h

@@ -366,7 +366,9 @@ rtems_status_code rtems_timer_fire_when(
 );
 
 /**
- *  @brief rtems_timer_server_fire_when
+ *  @brief RTEMS Timer Server Fire When Directive
+ *
+ *  Timer Manager - RTEMS Timer Server Fire When Directive
  *
  *  This routine implements the rtems_timer_server_fire_when directive.  It
  *  initiates the timer associated with ID to fire at wall_time
@@ -382,7 +384,9 @@ rtems_status_code rtems_timer_server_fire_when(
 );
 
 /**
- *  @brief rtems_timer_reset
+ *  @brief RTEMS Timer Reset
+ *
+ *  Timer Manager - RTEMS Timer Reset
  *
  *  This routine implements the rtems_timer_reset directive.  It is used
  *  to reinitialize the interval timer associated with ID just as if

cpukit/rtems/src/barriercreate.c

@@ -1,6 +1,11 @@
-/*
- *  Barrier Manager -- Create a Barrier Instance
+/**
+ * @file
  *
+ * @brief RTEMS Create Barrier
+ * @ingroup ClassicBarrier Barriers
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2006.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/rtems/src/barrierdata.c

@@ -1,6 +1,11 @@
-/*
- *  Barrier Manager -- Instantiate Data
+/**
+ * @file
  *
+ * @brief Instantiate Barrier Data
+ * @ingroup ClassicBarrier Barriers
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/rtems/src/barrierrelease.c

@@ -1,6 +1,11 @@
-/*
- *  Barrier Manager -- Release Tasks Waitng at a Barrier
+/**
+ * @file
  *
+ * @brief RTEMS Barrier Release
+ * @ingroup ClassicBarrier Barriers
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/rtems/src/eventreceive.c

@@ -1,6 +1,11 @@
-/*
- *  Event Manager
+/**
+ * @file
  *
+ * @brief  Constant used to receive the set of currently pending events in
+ * @ingroup ClassicEventSet Event Set
+ */
+
+/*
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/rtems/src/eventseize.c

@@ -1,6 +1,11 @@
-/*
- *  Event Manager
+/**
+ * @file
  *
+ * @brief Event Manager Initialization
+ * @ingroup ClassicEvent Events
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/rtems/src/msgmp.c

@@ -1,7 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Multiprocessing Support for the Message Queue Manager
+ * @ingroup ClassicMsgMP Message Queue MP Support
+ */
+
 /*
- *  Multiprocessing Support for the Message Queue Manager
- *
- *
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/rtems/src/msgqgetnumberpending.c

@@ -1,7 +1,11 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Message Queue Get Number Pending
+ * @ingroup ClassicMessageQueue Message Queues
+ */
+
 /*
- *  Message Queue Manager
- *
- *
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/rtems/src/partcreate.c

@@ -1,7 +1,11 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Partition Create
+ * @ingroup ClassicPart Partitions
+ */
+
 /*
- *  Partition Manager
- *
- *
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/rtems/src/ratemoncreate.c

@@ -1,6 +1,11 @@
-/*
- *  Rate Monotonic Manager -- Create a Period
+/**
+ * @file
  *
+ * @brief Create a Period
+ * @ingroup ClassicRateMon Rate Monotonic Scheduler
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/rtems/src/ratemonresetstatistics.c

@@ -1,6 +1,11 @@
-/*
- *  Rate Monotonic Manager -- Reset Statistics
+/**
+ * @file
  *
+ * @brief RTEMS Rate Monotonic Reset Statistics
+ * @ingroup ClassicRateMon Rate Monotonic Scheduler
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/rtems/src/rtemsobjectidgetapi.c

@@ -1,6 +1,11 @@
-/*
- *  RTEMS Object Helper -- Extract API From Id
+/**
+ * @file
  *
+ * @brief Get API Portion of Object Id
+ * @ingroup ClassicClassInfo Object Class Information
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/rtems/src/semrelease.c

@@ -1,5 +1,8 @@
-/*
- *  Semaphore Manager
+/**
+ * @file
+ *
+ * @brief RTEMS Semaphore Release
+ * @ingroup ClassicSem Semaphores
  *
  *  DESCRIPTION:
  *
@@ -15,6 +18,9 @@
  *     + acquire a semaphore
  *     + release a semaphore
  *
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/rtems/src/signal.c

@@ -1,7 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Signal Manager Initialization
+ * @ingroup ClassicSignal Signals
+ */
+
 /*
- *  Signal Manager
- *
- *
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/rtems/src/taskmp.c

@@ -1,7 +1,11 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Tasks MP Send Process Packet
+ * @ingroup ClassicTaskMP Task MP Support
+ */
+
 /*
- *  Multiprocessing Support for the RTEMS Task Manager
- *
- *
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/rtems/src/taskstart.c

@@ -1,7 +1,11 @@
+/**
+ * @file
+ *
+ * @brief  RTEMS Start Task
+ * @ingroup ClassicTasks Tasks
+ */
+
 /*
- *  RTEMS Task Manager
- *
- *
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/rtems/src/taskvariableget.c

@@ -1,7 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Get a per-task variable
+ * @ingroup ClassicTasks Tasks
+ */
+
 /*
- *  rtems_task_variable_get - Get a per-task variable
- *
- *
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/rtems/src/timerreset.c

@@ -1,7 +1,11 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Timer Reset
+ * @ingroup ClassicTimer Timers
+ */
+
 /*
- *  Timer Manager - rtems_timer_reset directive
- *
- *
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *

cpukit/rtems/src/timerserverfirewhen.c

@@ -1,7 +1,11 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Timer Server Fire When Directive
+ * @ingroup ClassicTimer Timers
+ */
+
 /*
- *  Timer Manager - rtems_timer_server fire_when directive
- *
- *
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *