summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@oarcorp.com>2013-01-10 13:20:34 -0600
committerJoel Sherrill <joel.sherrill@oarcorp.com>2013-01-10 17:06:47 -0600
commita15eaaf9fdba8a9311623ae44711d17701a19d30 (patch)
treeeb6f4439e820390ad8b0f8ed5a10ed6835461548 /cpukit/rtems
parentscore: Doxygen Clean Up Task #14 (diff)
downloadrtems-a15eaaf9fdba8a9311623ae44711d17701a19d30.tar.bz2
cpukit: Doxygen group fixes and many warnings addressed
The output of the modules.html is much improved. Most filesystem and POSIX API related groups are properly nested. Some formatting issues were addressed as were multiple inconsistencies.
Diffstat (limited to '')
-rw-r--r--cpukit/rtems/include/rtems.h4
-rw-r--r--cpukit/rtems/include/rtems/rtems/barriermp.h5
-rw-r--r--cpukit/rtems/include/rtems/rtems/msgmp.h5
-rw-r--r--cpukit/rtems/include/rtems/rtems/partmp.h5
-rw-r--r--cpukit/rtems/include/rtems/rtems/sem.h3
-rw-r--r--cpukit/rtems/include/rtems/rtems/signalmp.h5
-rw-r--r--cpukit/rtems/mainpage.h3
7 files changed, 8 insertions, 22 deletions
diff --git a/cpukit/rtems/include/rtems.h b/cpukit/rtems/include/rtems.h
index d4af28a8ec..a644fa051c 100644
--- a/cpukit/rtems/include/rtems.h
+++ b/cpukit/rtems/include/rtems.h
@@ -3,7 +3,6 @@
*
* @defgroup ClassicRTEMS RTEMS Classic API
*
- * @ingroup ClassicRTEMS
* @brief RTEMS Classic API
*
* the Public Interface to the RTEMS Classic API
@@ -24,9 +23,8 @@
* @defgroup ClassicRTEMS RTEMS Classic API
*
* RTEMS Classic API definitions and modules.
- *
- * @{
*/
+/**@{*/
#ifdef __cplusplus
extern "C" {
diff --git a/cpukit/rtems/include/rtems/rtems/barriermp.h b/cpukit/rtems/include/rtems/rtems/barriermp.h
index da5d372c0a..d2a203b162 100644
--- a/cpukit/rtems/include/rtems/rtems/barriermp.h
+++ b/cpukit/rtems/include/rtems/rtems/barriermp.h
@@ -1,9 +1,6 @@
/**
* @file rtems/rtems/barriermp.h
*
- * @defgroup ClassicBarrierMP Barrier MP Support
- *
- * @ingroup ClassicMP
* @brief MP Support in the Barrier Manager
*
* This include file contains all the constants and structures associated
@@ -28,7 +25,7 @@
*
* This encapsulates functionality which XXX
*/
-/**{*/
+/**@{*/
#ifdef __cplusplus
extern "C" {
diff --git a/cpukit/rtems/include/rtems/rtems/msgmp.h b/cpukit/rtems/include/rtems/rtems/msgmp.h
index 5d895dea1c..f01a687ae3 100644
--- a/cpukit/rtems/include/rtems/rtems/msgmp.h
+++ b/cpukit/rtems/include/rtems/rtems/msgmp.h
@@ -1,9 +1,6 @@
/**
* @file rtems/rtems/msgmp.h
*
- * @defgroup ClassicMsgMP Message Queue MP Support
- *
- * @ingroup ClassicRTEMS
* @brief Message Manager MP Support
*
* This include file contains all the constants and structures associated
@@ -39,7 +36,7 @@ extern "C" {
*
* This encapsulates functionality which XXX
*/
-/**{*/
+/*{*/
/**
* The following enumerated type defines the list of
diff --git a/cpukit/rtems/include/rtems/rtems/partmp.h b/cpukit/rtems/include/rtems/rtems/partmp.h
index 0405f8036b..3d3f47fe52 100644
--- a/cpukit/rtems/include/rtems/rtems/partmp.h
+++ b/cpukit/rtems/include/rtems/rtems/partmp.h
@@ -1,9 +1,6 @@
/**
* @file rtems/rtems/partmp.h
*
- * @defgroup ClassicPartMP Partition MP Support
- *
- * @ingroup ClassicMP
* @brief MP Support in Partition Manager
*
* This include file contains all the constants and structures associated
@@ -39,7 +36,7 @@ extern "C" {
*
* This encapsulates functionality which XXX
*/
-/**{*/
+/*{*/
/**
* The following enumerated type defines the list of
diff --git a/cpukit/rtems/include/rtems/rtems/sem.h b/cpukit/rtems/include/rtems/rtems/sem.h
index bc5f4dc30b..4442b1d68c 100644
--- a/cpukit/rtems/include/rtems/rtems/sem.h
+++ b/cpukit/rtems/include/rtems/rtems/sem.h
@@ -1,10 +1,11 @@
/**
* @file rtems/rtems/sem.h
*
+ * @brief Semaphore Manager
+ *
* @defgroup ClassicSem Semaphores
*
* @ingroup ClassicRTEMS
- * @brief Semaphore Manager
*
* This include file contains all the constants and structures associated
* with the Semaphore Manager. This manager utilizes standard Dijkstra
diff --git a/cpukit/rtems/include/rtems/rtems/signalmp.h b/cpukit/rtems/include/rtems/rtems/signalmp.h
index de32f3cc0e..82a7e07ef8 100644
--- a/cpukit/rtems/include/rtems/rtems/signalmp.h
+++ b/cpukit/rtems/include/rtems/rtems/signalmp.h
@@ -1,9 +1,6 @@
/**
* @file rtems/rtems/signalmp.h
*
- * @defgroup ClassicSignalMP Signal MP Support
- *
- * @ingroup ClassicRTEMS
* @brief Signal MP Support
*
* This include file contains all the constants and structures associated
@@ -38,7 +35,7 @@ extern "C" {
*
* This encapsulates functionality which XXX
*/
-/**{*/
+/*{*/
/**
* The following enumerated type defines the list of
diff --git a/cpukit/rtems/mainpage.h b/cpukit/rtems/mainpage.h
index 5aee1ccc46..b772b37892 100644
--- a/cpukit/rtems/mainpage.h
+++ b/cpukit/rtems/mainpage.h
@@ -391,11 +391,10 @@
* of RTEMS' concepts and features are interrelated. Experienced RTEMS users
* will find that the manual organization facilitates its use as a reference
* document.
- *
*/
/**
- * @addtogroup ClassicRTEMS
+ * @addtogroup ClassicAPI
*
* The facilities provided by RTEMS are built upon a foundation of very
* powerful concepts. These concepts must be understood before the application