rtems misc: Clean up Doxygen GCI Task #5

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

20 files changed, 140 insertions, 58 deletions

diff --git a/cpukit/rtems/src/clockgettod.c b/cpukit/rtems/src/clockgettod.c
index dd68ec578d..18f7773912 100644
--- a/cpukit/rtems/src/clockgettod.c
+++ b/cpukit/rtems/src/clockgettod.c
@@ -1,6 +1,11 @@
-/*
- *  Clock Manager - rtems_clock_get_tod
+/**
+ * @file
  *
+ * @brief Obtain Current Time of Day (Classic TOD)
+ * @ingroup ClassicClock Clocks
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/clockgetuptime.c b/cpukit/rtems/src/clockgetuptime.c
index 05d2575b60..848fd34b04 100644
--- a/cpukit/rtems/src/clockgetuptime.c
+++ b/cpukit/rtems/src/clockgetuptime.c
@@ -1,6 +1,11 @@
-/*
- *  Clock Manager - get uptime
+/**
+ * @file
  *
+ * @brief Obtain the System Uptime
+ * @ingroup ClassicClock Clocks
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/clockgetuptimeseconds.c b/cpukit/rtems/src/clockgetuptimeseconds.c
index dc98d1d9e9..655a18e1e3 100644
--- a/cpukit/rtems/src/clockgetuptimeseconds.c
+++ b/cpukit/rtems/src/clockgetuptimeseconds.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Returns the system uptime in seconds.
+ * @ingroup ClassicClock Clocks
+ */
+
 /*
  * Copyright (c) 2012 embedded brains GmbH.  All rights reserved.
  *
diff --git a/cpukit/rtems/src/clocksetnsecshandler.c b/cpukit/rtems/src/clocksetnsecshandler.c
index 100db9b167..80cf1dd8e6 100644
--- a/cpukit/rtems/src/clocksetnsecshandler.c
+++ b/cpukit/rtems/src/clocksetnsecshandler.c
@@ -1,6 +1,11 @@
-/*
- *  Clock Manager
+/**
+ * @file
  *
+ * @brief Set the BSP specific Nanoseconds Extension
+ * @ingroup ClassicClock Clocks
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2006.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/dpmemdata.c b/cpukit/rtems/src/dpmemdata.c
index 088fefea23..dac78730c7 100644
--- a/cpukit/rtems/src/dpmemdata.c
+++ b/cpukit/rtems/src/dpmemdata.c
@@ -1,6 +1,11 @@
-/*
- *  Dual Port Memory Manager -- Instantiate Data
+/**
+ * @file
  *
+ * @brief Define the internal Dual Ported Memory information
+ * @ingroup ClassicDPMEM Dual Ported Memory
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/msgqflush.c b/cpukit/rtems/src/msgqflush.c
index e62047ef0e..a14e96dae0 100644
--- a/cpukit/rtems/src/msgqflush.c
+++ b/cpukit/rtems/src/msgqflush.c
@@ -1,7 +1,11 @@
-/*
- *  Message Queue Manager
- *
+/**
+ * @file
  *
+ * @brief rtems_message_queue_flush
+ * @ingroup ClassicMessageQueue Message Queues
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/msgqsend.c b/cpukit/rtems/src/msgqsend.c
index 5fbcfa1c0a..764859d745 100644
--- a/cpukit/rtems/src/msgqsend.c
+++ b/cpukit/rtems/src/msgqsend.c
@@ -1,6 +1,11 @@
-/*
- *  Message Queue Manager - rtems_message_queue_send
+/**
+ * @file
  *
+ * @brief rtems_message_queue_send
+ * @ingroup ClassicMessageQueue Message Queues
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/partdata.c b/cpukit/rtems/src/partdata.c
index 10332f1dba..b568c4dc0c 100644
--- a/cpukit/rtems/src/partdata.c
+++ b/cpukit/rtems/src/partdata.c
@@ -1,6 +1,11 @@
-/*
- *  Partition Manager -- Instantiate Data
+/**
+ * @file
  *
+ * @brief Instantiate RTEMS Partition Data
+ * @ingroup ClassicPart Partitions
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/partmp.c b/cpukit/rtems/src/partmp.c
index 6a1fbc9878..2928238924 100644
--- a/cpukit/rtems/src/partmp.c
+++ b/cpukit/rtems/src/partmp.c
@@ -1,7 +1,11 @@
-/*
- *  Multiprocessing Support for the Partition Manager
- *
+/**
+ * @file
  *
+ * @brief Partition_MP_Send_process_packet
+ * @ingroup ClassicPartMP Partition MP Support
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/ratemonresetall.c b/cpukit/rtems/src/ratemonresetall.c
index 5a6fbd1b2b..b2ed414149 100644
--- a/cpukit/rtems/src/ratemonresetall.c
+++ b/cpukit/rtems/src/ratemonresetall.c
@@ -1,6 +1,11 @@
-/*
- *  Rate Monotonic Manager -- Reset Statistics for All Periods
+/**
+ * @file
  *
+ * @brief rtems_rate_monotonic_reset_all_statistics
+ * @ingroup ClassicRateMon Rate Monotonic Scheduler
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2010.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/region.c b/cpukit/rtems/src/region.c
index 2fdc3ca222..309b3c6c00 100644
--- a/cpukit/rtems/src/region.c
+++ b/cpukit/rtems/src/region.c
@@ -1,7 +1,11 @@
-/*
- *  Region Manager
- *
+/**
+ * @file
  *
+ * @brief _Region_Manager_initialization
+ * @ingroup ClassicRegion Regions
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/regioncreate.c b/cpukit/rtems/src/regioncreate.c
index f97c85a65f..753835536a 100644
--- a/cpukit/rtems/src/regioncreate.c
+++ b/cpukit/rtems/src/regioncreate.c
@@ -1,7 +1,11 @@
-/*
- *  Region Manager
- *
+/**
+ * @file
  *
+ * @brief rtems_region_create
+ * @ingroup ClassicRegion Regions
+ */
+
+/*
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/regiondata.c b/cpukit/rtems/src/regiondata.c
index 4f5c3da816..97fdc112f1 100644
--- a/cpukit/rtems/src/regiondata.c
+++ b/cpukit/rtems/src/regiondata.c
@@ -1,6 +1,11 @@
-/*
- *  Region Manager -- Instantiate Data
+/**
+ * @file
  *
+ * @brief Instantiate RTEMS Region Data
+ * @ingroup ClassicRegion Regions
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/rtemsbuildid.c b/cpukit/rtems/src/rtemsbuildid.c
index b72e145c73..7c2c48d5fe 100644
--- a/cpukit/rtems/src/rtemsbuildid.c
+++ b/cpukit/rtems/src/rtemsbuildid.c
@@ -1,6 +1,11 @@
-/*
- *  RTEMS Object Helper -- Build an Object Id
+/**
+ * @file
  *
+ * @brief Build Object Id
+ * @ingroup ClassicClassInfo Object Class Information
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/rtemsobjectapiminimumclass.c b/cpukit/rtems/src/rtemsobjectapiminimumclass.c
index 8b0e78ae7a..858bc37ddb 100644
--- a/cpukit/rtems/src/rtemsobjectapiminimumclass.c
+++ b/cpukit/rtems/src/rtemsobjectapiminimumclass.c
@@ -1,6 +1,11 @@
-/*
- *  RTEMS Object Helper -- Get Least Valid Class for an API
+/**
+ * @file
  *
+ * @brief Get Lowest Valid Class Value
+ * @ingroup ClassicClassInfo Object Class Information
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/rtemsobjectsetname.c b/cpukit/rtems/src/rtemsobjectsetname.c
index e67d77f3b4..2f61231031 100644
--- a/cpukit/rtems/src/rtemsobjectsetname.c
+++ b/cpukit/rtems/src/rtemsobjectsetname.c
@@ -1,6 +1,11 @@
-/*
- *  RTEMS Object Helper -- Set Name of Object as String
+/**
+ * @file
  *
+ * @brief Set Name of Object
+ * @ingroup ClassicClassInfo Object Class Information
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/semcreate.c b/cpukit/rtems/src/semcreate.c
index a25789064e..e7f7b77c50 100644
--- a/cpukit/rtems/src/semcreate.c
+++ b/cpukit/rtems/src/semcreate.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 rtems_semaphore_create
+ * @ingroup ClassicSem Semaphores
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2009.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/semdata.c b/cpukit/rtems/src/semdata.c
index accab0ef44..d19f0cc876 100644
--- a/cpukit/rtems/src/semdata.c
+++ b/cpukit/rtems/src/semdata.c
@@ -1,6 +1,11 @@
-/*
- *  Semaphore Manager -- Data Instantiation
+/**
+ * @file
  *
+ * @brief Instantiate Semaphore Data
+ * @ingroup ClassicSem Semaphores
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/taskinitusers.c b/cpukit/rtems/src/taskinitusers.c
index 2f4f0f9345..30cc81ae05 100644
--- a/cpukit/rtems/src/taskinitusers.c
+++ b/cpukit/rtems/src/taskinitusers.c
@@ -1,7 +1,11 @@
-/*
- *  RTEMS Task Manager
- *
+/**
+ * @file
  *
+ * @brief _RTEMS_tasks_Initialize_user_tasks_body
+ * @ingroup ClassicTasks Tasks
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/taskissuspended.c b/cpukit/rtems/src/taskissuspended.c
index 179c41e366..6a62dd5b2a 100644
--- a/cpukit/rtems/src/taskissuspended.c
+++ b/cpukit/rtems/src/taskissuspended.c
@@ -1,7 +1,11 @@
-/*
- *  RTEMS Task Manager
- *
+/**
+ * @file
  *
+ * @brief rtems_task_is_suspended
+ * @ingroup ClassicTasks Tasks
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *