misc rtems: Clean up Doxygen GCI Task #8

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

18 files changed, 127 insertions, 45 deletions

diff --git a/cpukit/rtems/src/barriercreate.c b/cpukit/rtems/src/barriercreate.c
index 80d616f1b1..b2450148d0 100644
--- a/cpukit/rtems/src/barriercreate.c
+++ b/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).
  *
diff --git a/cpukit/rtems/src/barrierdata.c b/cpukit/rtems/src/barrierdata.c
index f9e03fb5a8..6481dbc3f7 100644
--- a/cpukit/rtems/src/barrierdata.c
+++ b/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).
  *
diff --git a/cpukit/rtems/src/barrierrelease.c b/cpukit/rtems/src/barrierrelease.c
index 2393d66aab..550d82a2dd 100644
--- a/cpukit/rtems/src/barrierrelease.c
+++ b/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).
  *
diff --git a/cpukit/rtems/src/eventreceive.c b/cpukit/rtems/src/eventreceive.c
index 0361d2c56b..a6e32ba8f8 100644
--- a/cpukit/rtems/src/eventreceive.c
+++ b/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).
  *
diff --git a/cpukit/rtems/src/eventseize.c b/cpukit/rtems/src/eventseize.c
index c88f3f724b..4cb1f80d69 100644
--- a/cpukit/rtems/src/eventseize.c
+++ b/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).
  *
diff --git a/cpukit/rtems/src/msgmp.c b/cpukit/rtems/src/msgmp.c
index 666fad21ba..39f824750b 100644
--- a/cpukit/rtems/src/msgmp.c
+++ b/cpukit/rtems/src/msgmp.c
@@ -1,7 +1,11 @@
-/*
- *  Multiprocessing Support for the Message Queue Manager
- *
+/**
+ * @file
  *
+ * @brief Multiprocessing Support for the Message Queue Manager
+ * @ingroup ClassicMsgMP Message Queue MP Support
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/msgqgetnumberpending.c b/cpukit/rtems/src/msgqgetnumberpending.c
index 9941317652..0139144623 100644
--- a/cpukit/rtems/src/msgqgetnumberpending.c
+++ b/cpukit/rtems/src/msgqgetnumberpending.c
@@ -1,7 +1,11 @@
-/*
- *  Message Queue Manager
- *
+/**
+ * @file
  *
+ * @brief RTEMS Message Queue Get Number Pending
+ * @ingroup ClassicMessageQueue Message Queues
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/partcreate.c b/cpukit/rtems/src/partcreate.c
index ae1ec709b8..536f56e294 100644
--- a/cpukit/rtems/src/partcreate.c
+++ b/cpukit/rtems/src/partcreate.c
@@ -1,7 +1,11 @@
-/*
- *  Partition Manager
- *
+/**
+ * @file
  *
+ * @brief RTEMS Partition Create
+ * @ingroup ClassicPart Partitions
+ */
+
+/*
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/ratemoncreate.c b/cpukit/rtems/src/ratemoncreate.c
index 80627f224a..2e5e975d5d 100644
--- a/cpukit/rtems/src/ratemoncreate.c
+++ b/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).
  *
diff --git a/cpukit/rtems/src/ratemonresetstatistics.c b/cpukit/rtems/src/ratemonresetstatistics.c
index 7a38fee380..a9d3934742 100644
--- a/cpukit/rtems/src/ratemonresetstatistics.c
+++ b/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).
  *
diff --git a/cpukit/rtems/src/rtemsobjectidgetapi.c b/cpukit/rtems/src/rtemsobjectidgetapi.c
index 88bf30b8fb..bce0eaadf6 100644
--- a/cpukit/rtems/src/rtemsobjectidgetapi.c
+++ b/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).
  *
diff --git a/cpukit/rtems/src/semrelease.c b/cpukit/rtems/src/semrelease.c
index dea8f0bd77..66009667b7 100644
--- a/cpukit/rtems/src/semrelease.c
+++ b/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).
  *
diff --git a/cpukit/rtems/src/signal.c b/cpukit/rtems/src/signal.c
index 9528490db1..13e04d3fdf 100644
--- a/cpukit/rtems/src/signal.c
+++ b/cpukit/rtems/src/signal.c
@@ -1,7 +1,11 @@
-/*
- *  Signal Manager
- *
+/**
+ * @file
  *
+ * @brief Signal Manager Initialization
+ * @ingroup ClassicSignal Signals
+ */
+
+/*
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/taskmp.c b/cpukit/rtems/src/taskmp.c
index ead2513401..c48d9c78c5 100644
--- a/cpukit/rtems/src/taskmp.c
+++ b/cpukit/rtems/src/taskmp.c
@@ -1,7 +1,11 @@
-/*
- *  Multiprocessing Support for the RTEMS Task Manager
- *
+/**
+ * @file
  *
+ * @brief RTEMS Tasks MP Send Process Packet
+ * @ingroup ClassicTaskMP Task MP Support
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/taskstart.c b/cpukit/rtems/src/taskstart.c
index c6f1078902..4a168bf742 100644
--- a/cpukit/rtems/src/taskstart.c
+++ b/cpukit/rtems/src/taskstart.c
@@ -1,7 +1,11 @@
-/*
- *  RTEMS Task Manager
- *
+/**
+ * @file
  *
+ * @brief  RTEMS Start Task
+ * @ingroup ClassicTasks Tasks
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/taskvariableget.c b/cpukit/rtems/src/taskvariableget.c
index 8801a24538..d2074b274b 100644
--- a/cpukit/rtems/src/taskvariableget.c
+++ b/cpukit/rtems/src/taskvariableget.c
@@ -1,7 +1,11 @@
-/*
- *  rtems_task_variable_get - Get a per-task variable
- *
+/**
+ * @file
  *
+ * @brief Get a per-task variable
+ * @ingroup ClassicTasks Tasks
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/timerreset.c b/cpukit/rtems/src/timerreset.c
index e86957c9de..0e8052161f 100644
--- a/cpukit/rtems/src/timerreset.c
+++ b/cpukit/rtems/src/timerreset.c
@@ -1,7 +1,11 @@
-/*
- *  Timer Manager - rtems_timer_reset directive
- *
+/**
+ * @file
  *
+ * @brief RTEMS Timer Reset
+ * @ingroup ClassicTimer Timers
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/timerserverfirewhen.c b/cpukit/rtems/src/timerserverfirewhen.c
index 5f029a0d35..11a1e15dc8 100644
--- a/cpukit/rtems/src/timerserverfirewhen.c
+++ b/cpukit/rtems/src/timerserverfirewhen.c
@@ -1,7 +1,11 @@
-/*
- *  Timer Manager - rtems_timer_server fire_when directive
- *
+/**
+ * @file
  *
+ * @brief RTEMS Timer Server Fire When Directive
+ * @ingroup ClassicTimer Timers
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *