rtems misc: Clean up Doxygen GCI Task #6

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

19 files changed, 129 insertions, 299 deletions

diff --git a/cpukit/rtems/src/barrierdelete.c b/cpukit/rtems/src/barrierdelete.c
index 9811773ac6..a73846dc6e 100644
--- a/cpukit/rtems/src/barrierdelete.c
+++ b/cpukit/rtems/src/barrierdelete.c
@@ -1,6 +1,11 @@
-/*
- *  Barrier Manager -- Delete a Barrier
+/**
+ *  @file
  *
+ *  @brief RTEMS Delete Barrier
+ *  @ingroup ClassicBarrier
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -21,21 +26,6 @@
 #include <rtems/score/thread.h>
 #include <rtems/score/threadq.h>
 
-/*
- *  rtems_barrier_delete
- *
- *  This directive allows a thread to delete a barrier specified by
- *  the barrier id.  The barrier is freed back to the inactive
- *  barrier chain.
- *
- *  Input parameters:
- *    id - barrier id
- *
- *  Output parameters:
- *    RTEMS_SUCCESSFUL - if successful
- *    error code       - if unsuccessful
- */
-
 rtems_status_code rtems_barrier_delete(
   rtems_id   id
 )
diff --git a/cpukit/rtems/src/dpmemcreate.c b/cpukit/rtems/src/dpmemcreate.c
index 7ac6ae91fb..6987670e61 100644
--- a/cpukit/rtems/src/dpmemcreate.c
+++ b/cpukit/rtems/src/dpmemcreate.c
@@ -1,6 +1,11 @@
-/*
- *  Dual Port Memory Manager
+/**
+ *  @file
  *
+ *  @brief RTEMS Create Port
+ *  @ingroup ClassicDPMEM
+ */
+
+/*
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -22,24 +27,6 @@
 #include <rtems/score/thread.h>
 #include <rtems/rtems/dpmem.h>
 
-/*
- *  rtems_port_create
- *
- *  This directive creates a port into a dual-ported memory area.
- *
- *  Input parameters:
- *    name           - user defined port name
- *    internal_start - internal start address of port
- *    external_start - external start address of port
- *    length         - physical length in bytes
- *    id             - address of port id to set
- *
- *  Output parameters:
- *    id       - port id
- *    RTEMS_SUCCESSFUL - if successful
- *    error code - if unsuccessful
- */
-
 rtems_status_code rtems_port_create(
   rtems_name    name,
   void         *internal_start,
diff --git a/cpukit/rtems/src/dpmemdelete.c b/cpukit/rtems/src/dpmemdelete.c
index 02c3fbb901..4f78035346 100644
--- a/cpukit/rtems/src/dpmemdelete.c
+++ b/cpukit/rtems/src/dpmemdelete.c
@@ -1,6 +1,11 @@
-/*
- *  Dual Port Memory Manager
+/**
+ *  @file
  *
+ *  @brief RTEMS Delete Port
+ *  @ingroup ClassicDPMEM
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -22,20 +27,6 @@
 #include <rtems/score/thread.h>
 #include <rtems/rtems/dpmem.h>
 
-/*
- *  rtems_port_delete
- *
- *  This directive allows a thread to delete a dual-ported memory area
- *  specified by the dual-ported memory identifier.
- *
- *  Input parameters:
- *    id - dual-ported memory area id
- *
- *  Output parameters:
- *    RTEMS_SUCCESSFUL - if successful
- *    error code        - if unsuccessful
- */
-
 rtems_status_code rtems_port_delete(
   rtems_id id
 )
diff --git a/cpukit/rtems/src/modes.c b/cpukit/rtems/src/modes.c
index 0c51281177..6e4acff225 100644
--- a/cpukit/rtems/src/modes.c
+++ b/cpukit/rtems/src/modes.c
@@ -1,12 +1,11 @@
 /**
  *  @file
  *
- *  @body Body for Mode Routines Implemented as Macros
- *
- *  This file contains bodies for Mode Macros which are
- *  needed by language bindings other than C and C++.
+ *  @brief Body for RTEMS_INTERRUPT_LEVEL Macro
+ *  @ingroup ClassicModes
  */
 
+
 /*
  *  COPYRIGHT (c) 1989-2012.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/rtems/src/part.c b/cpukit/rtems/src/part.c
index 65e5331ed0..042cdaf19a 100644
--- a/cpukit/rtems/src/part.c
+++ b/cpukit/rtems/src/part.c
@@ -1,6 +1,11 @@
-/*
- *  Partition Manager
+/**
+ *  @file
  *
+ *  @brief Partition Manager Initialization
+ *  @ingroup ClassicPart
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -23,17 +28,6 @@
 #include <rtems/score/thread.h>
 #include <rtems/score/sysstate.h>
 
-/*
- *  _Partition_Manager_initialization
- *
- *  This routine initializes all partition manager related
- *  data structures.
- *
- *  Input parameters:   NONE
- *
- *  Output parameters:  NONE
- */
-
 void _Partition_Manager_initialization(void)
 {
   _Objects_Initialize_information(
diff --git a/cpukit/rtems/src/regiondelete.c b/cpukit/rtems/src/regiondelete.c
index d691bedd5e..8ad5085553 100644
--- a/cpukit/rtems/src/regiondelete.c
+++ b/cpukit/rtems/src/regiondelete.c
@@ -1,7 +1,11 @@
-/*
- *  Region Manager
- *
+/**
+ *  @file
  *
+ *  @brief RTEMS Delete Region
+ *  @ingroup ClassicRegion
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -24,21 +28,6 @@
 #include <rtems/score/thread.h>
 #include <rtems/score/apimutex.h>
 
-/*
- *  rtems_region_delete
- *
- *  This directive allows a thread to delete a region specified by
- *  the region identifier, provided that none of its segments are
- *  still allocated.
- *
- *  Input parameters:
- *    id - region id
- *
- *  Output parameters:
- *    RTEMS_SUCCESSFUL - if successful
- *    error code       - if unsuccessful
- */
-
 rtems_status_code rtems_region_delete(
   rtems_id id
 )
diff --git a/cpukit/rtems/src/regionextend.c b/cpukit/rtems/src/regionextend.c
index 205534b246..d5e3cd645e 100644
--- a/cpukit/rtems/src/regionextend.c
+++ b/cpukit/rtems/src/regionextend.c
@@ -1,6 +1,11 @@
-/*
- *  Region Manager - Extend (add memory to) a Region
+/**
+ *  @file
  *
+ *  @brief RTEMS Extend Region
+ *  @ingroup ClassicRegion
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2009.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -23,22 +28,6 @@
 #include <rtems/score/thread.h>
 #include <rtems/score/apimutex.h>
 
-/*
- *  rtems_region_extend
- *
- *  This directive attempts to grow a region of physical contiguous memory area
- *  from which variable sized segments can be allocated.
- *
- *  Input parameters:
- *    id         - id of region to grow
- *    start      - starting address of memory area for extension
- *    length     - physical length in bytes to grow the region
- *
- *  Output parameters:
- *    RTEMS_SUCCESSFUL - if successful
- *    error code       - if unsuccessful
- */
-
 rtems_status_code rtems_region_extend(
   rtems_id   id,
   void      *starting_address,
diff --git a/cpukit/rtems/src/regiongetsegmentsize.c b/cpukit/rtems/src/regiongetsegmentsize.c
index 8333d160dd..94a66866f1 100644
--- a/cpukit/rtems/src/regiongetsegmentsize.c
+++ b/cpukit/rtems/src/regiongetsegmentsize.c
@@ -1,7 +1,11 @@
-/*
- *  Region Manager
- *
+/**
+ *  @file
  *
+ *  @brief RTEMS Get Region Segment Size
+ *  @ingroup ClassicRegion
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -23,22 +27,6 @@
 #include <rtems/score/states.h>
 #include <rtems/score/apimutex.h>
 
-/*
- *  rtems_region_get_segment_size
- *
- *  This directive will return the size of the segment indicated
- *
- *  Input parameters:
- *    id         - region id
- *    segment    - segment address
- *    size       - pointer to segment size in bytes
- *
- *  Output parameters:
- *    size       - segment size in bytes filled in
- *    RTEMS_SUCCESSFUL - if successful
- *    error code - if unsuccessful
- */
-
 rtems_status_code rtems_region_get_segment_size(
   rtems_id   id,
   void      *segment,
diff --git a/cpukit/rtems/src/regionident.c b/cpukit/rtems/src/regionident.c
index 6e1809230c..ca15664ed6 100644
--- a/cpukit/rtems/src/regionident.c
+++ b/cpukit/rtems/src/regionident.c
@@ -1,7 +1,11 @@
-/*
- *  Region Manager
- *
+/**
+ *  @file
  *
+ *  @brief RTEMS Region Name to Id
+ *  @ingroup ClassicRegion
+ */
+
+/*
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -24,22 +28,6 @@
 #include <rtems/score/thread.h>
 #include <rtems/score/apimutex.h>
 
-/*
- *  rtems_region_ident
- *
- *  This directive returns the system ID associated with
- *  the region name.
- *
- *  Input parameters:
- *    name - user defined region name
- *    id   - pointer to region id
- *
- *  Output parameters:
- *    *id      - region id
- *    RTEMS_SUCCESSFUL - if successful
- *    error code - if unsuccessful
- */
-
 rtems_status_code rtems_region_ident(
   rtems_name  name,
   rtems_id   *id
diff --git a/cpukit/rtems/src/rtclock.c b/cpukit/rtems/src/rtclock.c
index 515788c808..fb4cb35b51 100644
--- a/cpukit/rtems/src/rtclock.c
+++ b/cpukit/rtems/src/rtclock.c
@@ -1,6 +1,11 @@
-/*
- *  Clock Manager
+/**
+ *  @file
  *
+ *  @brief No Initialization Routine
+ *  @ingroup ClassicClock
+ */
+
+/*
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/rtemsobjectidgetnode.c b/cpukit/rtems/src/rtemsobjectidgetnode.c
index eb97a37dd7..15f8cd8a3c 100644
--- a/cpukit/rtems/src/rtemsobjectidgetnode.c
+++ b/cpukit/rtems/src/rtemsobjectidgetnode.c
@@ -1,6 +1,11 @@
-/*
- *  RTEMS Object Helper -- Extract Node From Id
+/**
+ *  @file
  *
+ *  @brief Get Node Portion of Object Id
+ *  @ingroup ClassicClassInfo
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/rtemstimer.c b/cpukit/rtems/src/rtemstimer.c
index 6a8a3e0246..6bf33c1fb3 100644
--- a/cpukit/rtems/src/rtemstimer.c
+++ b/cpukit/rtems/src/rtemstimer.c
@@ -1,7 +1,11 @@
-/*
- *  Timer Manager
- *
+/**
+ *  @file
  *
+ *  @brief Timer Manager Initialization
+ *  @ingroup ClassicTimer
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -24,16 +28,6 @@
 #include <rtems/score/tod.h>
 #include <rtems/score/watchdog.h>
 
-/*
- *  _Timer_Manager_initialization
- *
- *  This routine initializes all timer manager related data structures.
- *
- *  Input parameters: NONE
- *
- *  Output parameters:  NONE
- */
-
 void _Timer_Manager_initialization(void)
 {
   _Objects_Initialize_information(
diff --git a/cpukit/rtems/src/semtranslatereturncode.c b/cpukit/rtems/src/semtranslatereturncode.c
index 2231df8d1b..a06a84871d 100644
--- a/cpukit/rtems/src/semtranslatereturncode.c
+++ b/cpukit/rtems/src/semtranslatereturncode.c
@@ -1,20 +1,11 @@
-/*
- *  Semaphore Manager
- *
- *  DESCRIPTION:
- *
- *  This package is the implementation of the Semaphore Manager.
- *  This manager utilizes standard Dijkstra counting semaphores to provide
- *  synchronization and mutual exclusion capabilities.
- *
- *  Directives provided are:
- *
- *     + create a semaphore
- *     + get an ID of a semaphore
- *     + delete a semaphore
- *     + acquire a semaphore
- *     + release a semaphore
+/**
+ *  @file
  *
+ *  @brief Semaphore Translate Core Mutex and Semaphore Return Code
+ *  @ingroup ClassicSem
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2009.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -47,17 +38,6 @@
 
 #include <rtems/score/interr.h>
 
-/*
- *  _Semaphore_Translate_core_mutex_return_code
- *
- *  Input parameters:
- *    status - mutex status code to translate
- *
- *  Output parameters:
- *    rtems status code - translated RTEMS status code
- *
- */
-
 const rtems_status_code _Semaphore_Translate_core_mutex_return_code_[] = {
   RTEMS_SUCCESSFUL,         /* CORE_MUTEX_STATUS_SUCCESSFUL */
   RTEMS_UNSATISFIED,        /* CORE_MUTEX_STATUS_UNSATISFIED_NOWAIT */
@@ -95,17 +75,6 @@ rtems_status_code _Semaphore_Translate_core_mutex_return_code (
   return _Semaphore_Translate_core_mutex_return_code_[status];
 }
 
-/*
- *  _Semaphore_Translate_core_semaphore_return_code
- *
- *  Input parameters:
- *    status - semaphore status code to translate
- *
- *  Output parameters:
- *    rtems status code - translated RTEMS status code
- *
- */
-
 const rtems_status_code _Semaphore_Translate_core_semaphore_return_code_[] = {
   RTEMS_SUCCESSFUL,         /* CORE_SEMAPHORE_STATUS_SUCCESSFUL */
   RTEMS_UNSATISFIED,        /* CORE_SEMAPHORE_STATUS_UNSATISFIED_NOWAIT */
diff --git a/cpukit/rtems/src/taskdelete.c b/cpukit/rtems/src/taskdelete.c
index 52045698f8..2f78301ae3 100644
--- a/cpukit/rtems/src/taskdelete.c
+++ b/cpukit/rtems/src/taskdelete.c
@@ -1,7 +1,11 @@
-/*
- *  RTEMS Task Manager
- *
+/**
+ *  @file
  *
+ *  @brief RTEMS Delete Task
+ *  @ingroup ClassicTasks
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -30,23 +34,6 @@
 #include <rtems/score/sysstate.h>
 #include <rtems/score/apimutex.h>
 
-/*
- *  rtems_task_delete
- *
- *  This directive allows a thread to delete itself or the thread
- *  identified in the id field.  The executive halts execution
- *  of the thread and frees the thread control block.
- *
- *  Input parameters:
- *    id - thread id
- *
- *  Output parameters:
- *    nothing           - if id is the requesting thread (always succeeds)
- *    RTEMS_SUCCESSFUL - if successful and id is
- *                           not the requesting thread
- *    error code        - if unsuccessful
- */
-
 rtems_status_code rtems_task_delete(
   rtems_id id
 )
diff --git a/cpukit/rtems/src/taskident.c b/cpukit/rtems/src/taskident.c
index 570aa3594a..2c3090909a 100644
--- a/cpukit/rtems/src/taskident.c
+++ b/cpukit/rtems/src/taskident.c
@@ -1,7 +1,11 @@
-/*
- *  RTEMS Task Manager
- *
+/**
+ *  @file
  *
+ *  @brief RTEMS Task Name to Id
+ *  @ingroup ClassicTasks
+ */
+
+/*
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -29,23 +33,6 @@
 #include <rtems/score/apiext.h>
 #include <rtems/score/sysstate.h>
 
-/*
- *  rtems_task_ident
- *
- *  This directive returns the system ID associated with
- *  the thread name.
- *
- *  Input parameters:
- *    name - user defined thread name
- *    node - node(s) to be searched
- *    id   - pointer to thread id
- *
- *  Output parameters:
- *    *id               - thread id
- *    RTEMS_SUCCESSFUL - if successful
- *    error code        - if unsuccessful
- */
-
 rtems_status_code rtems_task_ident(
   rtems_name    name,
   uint32_t      node,
diff --git a/cpukit/rtems/src/tasksuspend.c b/cpukit/rtems/src/tasksuspend.c
index e1e82ddd30..8128100c78 100644
--- a/cpukit/rtems/src/tasksuspend.c
+++ b/cpukit/rtems/src/tasksuspend.c
@@ -1,7 +1,11 @@
-/*
- *  RTEMS Task Manager
- *
+/**
+ *  @file
  *
+ *  @brief RTEMS Suspend Task
+ *  @ingroup ClassicTasks
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -29,21 +33,6 @@
 #include <rtems/score/apiext.h>
 #include <rtems/score/sysstate.h>
 
-/*
- *  rtems_task_suspend
- *
- *  This directive will place the specified thread in the "suspended"
- *  state.  Note that the suspended state can be in addition to
- *  other waiting states.
- *
- *  Input parameters:
- *    id - thread id
- *
- *  Output parameters:
- *    RTEMS_SUCCESSFUL - if successful
- *    error code        - if unsuccessful
- */
-
 rtems_status_code rtems_task_suspend(
   rtems_id id
 )
diff --git a/cpukit/rtems/src/taskvariable_invoke_dtor.c b/cpukit/rtems/src/taskvariable_invoke_dtor.c
index 9f797c45dc..76fc2687d7 100644
--- a/cpukit/rtems/src/taskvariable_invoke_dtor.c
+++ b/cpukit/rtems/src/taskvariable_invoke_dtor.c
@@ -1,7 +1,11 @@
-/*
- *  Invoke the destructor on a per-task variable
- *
+/**
+ *  @file
  *
+ *  @brief RTEMS Tasks Invoke Task Variable Destructor
+ *  @ingroup ClassicTasks
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/timerfirewhen.c b/cpukit/rtems/src/timerfirewhen.c
index df24e2aad3..487471ffc3 100644
--- a/cpukit/rtems/src/timerfirewhen.c
+++ b/cpukit/rtems/src/timerfirewhen.c
@@ -1,7 +1,11 @@
-/*
- *  Timer Manager - rtems_timer_fire_when directive
- *
+/**
+ *  @file
  *
+ *  @brief RTEMS Timer Fire When
+ *  @ingroup ClassicTimer
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -23,22 +27,6 @@
 #include <rtems/score/tod.h>
 #include <rtems/score/watchdog.h>
 
-/*
- *  rtems_timer_fire_when
- *
- *  This directive allows a thread to start a timer.
- *
- *  Input parameters:
- *    id        - timer id
- *    wall_time - time of day to fire timer
- *    routine   - routine to schedule
- *    user_data - passed as argument to routine when it is fired
- *
- *  Output parameters:
- *    RTEMS_SUCCESSFUL - if successful
- *    error code       - if unsuccessful
- */
-
 rtems_status_code rtems_timer_fire_when(
   rtems_id                            id,
   rtems_time_of_day                  *wall_time,
diff --git a/cpukit/rtems/src/timerserverfireafter.c b/cpukit/rtems/src/timerserverfireafter.c
index d515d5f919..ee8dc8f3da 100644
--- a/cpukit/rtems/src/timerserverfireafter.c
+++ b/cpukit/rtems/src/timerserverfireafter.c
@@ -1,7 +1,11 @@
-/*
- *  Timer Manager - rtems_timer_server fire_after directive
- *
+/**
+ *  @file
  *
+ *  @brief RTEMS Timer Server Fire After
+ *  @ingroup ClassicTimer
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -23,23 +27,6 @@
 #include <rtems/score/tod.h>
 #include <rtems/score/watchdog.h>
 
-/*
- *  rtems_timer_server_fire_after
- *
- *  This directive allows a thread to start a timer which will by
- *  executed by the Timer Server when it fires.
- *
- *  Input parameters:
- *    id        - timer id
- *    ticks     - interval until routine is fired
- *    routine   - routine to schedule
- *    user_data - passed as argument to routine when it is fired
- *
- *  Output parameters:
- *    RTEMS_SUCCESSFUL - if successful
- *    error code       - if unsuccessful
- */
-
 rtems_status_code rtems_timer_server_fire_after(
   rtems_id                           id,
   rtems_interval                     ticks,