summaryrefslogtreecommitdiffstats
path: root/cpukit/posix
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/posix
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 'cpukit/posix')
-rw-r--r--cpukit/posix/include/aio.h2
-rw-r--r--cpukit/posix/include/mqueue.h2
-rw-r--r--cpukit/posix/include/rtems/posix/cond.h2
-rw-r--r--cpukit/posix/include/rtems/posix/key.h2
-rw-r--r--cpukit/posix/include/rtems/posix/mqueue.h2
-rw-r--r--cpukit/posix/include/rtems/posix/mutex.h2
-rw-r--r--cpukit/posix/include/rtems/posix/priority.h2
-rw-r--r--cpukit/posix/include/rtems/posix/psignalimpl.h2
-rw-r--r--cpukit/posix/include/rtems/posix/pthread.h2
-rw-r--r--cpukit/posix/include/rtems/posix/ptimer.h2
-rw-r--r--cpukit/posix/include/rtems/posix/rwlock.h2
-rw-r--r--cpukit/posix/include/rtems/posix/semaphore.h10
-rw-r--r--cpukit/posix/include/rtems/posix/spinlock.h2
-rw-r--r--cpukit/posix/include/rtems/posix/threadsup.h4
-rw-r--r--cpukit/posix/include/rtems/posix/time.h2
-rw-r--r--cpukit/posix/include/rtems/posix/timer.h14
-rw-r--r--cpukit/posix/include/semaphore.h2
17 files changed, 29 insertions, 27 deletions
diff --git a/cpukit/posix/include/aio.h b/cpukit/posix/include/aio.h
index 769f0b37f2..f43e088930 100644
--- a/cpukit/posix/include/aio.h
+++ b/cpukit/posix/include/aio.h
@@ -28,7 +28,7 @@ extern "C" {
/**
* @defgroup POSIX_AIO POSIX Asynchronous I/O Support
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief POSIX Asynchronous Input and Output
*
diff --git a/cpukit/posix/include/mqueue.h b/cpukit/posix/include/mqueue.h
index a3e43ee712..2c228544de 100644
--- a/cpukit/posix/include/mqueue.h
+++ b/cpukit/posix/include/mqueue.h
@@ -43,7 +43,7 @@
/**
* @defgroup POSIX_MQUEUE POSIX Message Queues
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @{
*/
diff --git a/cpukit/posix/include/rtems/posix/cond.h b/cpukit/posix/include/rtems/posix/cond.h
index 5fdc1a1a31..2bd02604c0 100644
--- a/cpukit/posix/include/rtems/posix/cond.h
+++ b/cpukit/posix/include/rtems/posix/cond.h
@@ -22,7 +22,7 @@
/**
* @defgroup POSIX_COND_VARS POSIX Condition Variables
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @{
*/
diff --git a/cpukit/posix/include/rtems/posix/key.h b/cpukit/posix/include/rtems/posix/key.h
index f0f039ec1d..bd92a01316 100644
--- a/cpukit/posix/include/rtems/posix/key.h
+++ b/cpukit/posix/include/rtems/posix/key.h
@@ -24,7 +24,7 @@
/**
* @defgroup POSIX_KEY POSIX Key
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @{
*/
diff --git a/cpukit/posix/include/rtems/posix/mqueue.h b/cpukit/posix/include/rtems/posix/mqueue.h
index cef85e8045..1b24098170 100644
--- a/cpukit/posix/include/rtems/posix/mqueue.h
+++ b/cpukit/posix/include/rtems/posix/mqueue.h
@@ -40,7 +40,7 @@
/**
* @defgroup POSIX_MQUEUE_P Message Queues Private Support
*
- * @ingroup POSIX_MQUEUE
+ * @ingroup POSIXAPI
*
* @{
*/
diff --git a/cpukit/posix/include/rtems/posix/mutex.h b/cpukit/posix/include/rtems/posix/mutex.h
index f44a1c64b1..a84ed7ec77 100644
--- a/cpukit/posix/include/rtems/posix/mutex.h
+++ b/cpukit/posix/include/rtems/posix/mutex.h
@@ -26,7 +26,7 @@ extern "C" {
/**
* @defgroup POSIX_MUTEX POSIX Mutex Support
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief Private Support Information for POSIX Mutex
*
diff --git a/cpukit/posix/include/rtems/posix/priority.h b/cpukit/posix/include/rtems/posix/priority.h
index 1a12900057..cf47ed0677 100644
--- a/cpukit/posix/include/rtems/posix/priority.h
+++ b/cpukit/posix/include/rtems/posix/priority.h
@@ -22,7 +22,7 @@
/**
* @defgroup POSIX_PRIORITY POSIX Priority Support
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief Interface to the POSIX Priority Implementation
*
diff --git a/cpukit/posix/include/rtems/posix/psignalimpl.h b/cpukit/posix/include/rtems/posix/psignalimpl.h
index d09722ddbf..6db7948840 100644
--- a/cpukit/posix/include/rtems/posix/psignalimpl.h
+++ b/cpukit/posix/include/rtems/posix/psignalimpl.h
@@ -21,7 +21,7 @@
/**
* @defgroup POSIX_SIGNALS POSIX Signals Support
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief Internal Information about POSIX Signals
*
diff --git a/cpukit/posix/include/rtems/posix/pthread.h b/cpukit/posix/include/rtems/posix/pthread.h
index d0d2c2db5d..7037adc672 100644
--- a/cpukit/posix/include/rtems/posix/pthread.h
+++ b/cpukit/posix/include/rtems/posix/pthread.h
@@ -30,7 +30,7 @@ extern "C" {
/**
* @defgroup POSIX_PTHREAD POSIX Threads Support
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief Private Support Information for POSIX Threads
*
diff --git a/cpukit/posix/include/rtems/posix/ptimer.h b/cpukit/posix/include/rtems/posix/ptimer.h
index 50840ac5f6..9f6122ad04 100644
--- a/cpukit/posix/include/rtems/posix/ptimer.h
+++ b/cpukit/posix/include/rtems/posix/ptimer.h
@@ -25,7 +25,7 @@
/**
* @defgroup POSIX_PRIV_TIMERS POSIX Timers
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @{
*/
diff --git a/cpukit/posix/include/rtems/posix/rwlock.h b/cpukit/posix/include/rtems/posix/rwlock.h
index 57351be532..0dbd268aa3 100644
--- a/cpukit/posix/include/rtems/posix/rwlock.h
+++ b/cpukit/posix/include/rtems/posix/rwlock.h
@@ -32,7 +32,7 @@ extern "C" {
/**
* @defgroup POSIX_RWLOCK POSIX RWLock Manager
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief Constants and Structures Associated with the POSIX RWLock Manager
*
diff --git a/cpukit/posix/include/rtems/posix/semaphore.h b/cpukit/posix/include/rtems/posix/semaphore.h
index 031a511d70..3127c3f9aa 100644
--- a/cpukit/posix/include/rtems/posix/semaphore.h
+++ b/cpukit/posix/include/rtems/posix/semaphore.h
@@ -20,10 +20,14 @@
#define _RTEMS_POSIX_SEMAPHORE_H
/**
- * @addtogroup POSIX_SEMAPHORES
- *
- * @{
+ * @defgroup POSIXSemaphorePrivate POSIX Semaphore Private Support
+ *
+ * @ingroup POSIXAPI
+ *
+ * This defines the internal implementation support for POSIX semaphores.
*/
+/**@{*/
+
#ifdef __cplusplus
extern "C" {
#endif
diff --git a/cpukit/posix/include/rtems/posix/spinlock.h b/cpukit/posix/include/rtems/posix/spinlock.h
index a535c6bae6..c8af7fa03b 100644
--- a/cpukit/posix/include/rtems/posix/spinlock.h
+++ b/cpukit/posix/include/rtems/posix/spinlock.h
@@ -32,7 +32,7 @@ extern "C" {
/**
* @defgroup POSIX_SPINLOCK POSIX Spinlock Support
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief Constants and Structures Associated with the POSIX Spinlock Manager
*
diff --git a/cpukit/posix/include/rtems/posix/threadsup.h b/cpukit/posix/include/rtems/posix/threadsup.h
index 2d9c6adfa6..72fa1d35af 100644
--- a/cpukit/posix/include/rtems/posix/threadsup.h
+++ b/cpukit/posix/include/rtems/posix/threadsup.h
@@ -23,9 +23,9 @@
#include <rtems/score/tqdata.h>
/**
- * @defgroup POSIX_THREAD Thread API Extension
+ * @defgroup POSIX_THREAD POSIX Thread API Extension
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @{
*/
diff --git a/cpukit/posix/include/rtems/posix/time.h b/cpukit/posix/include/rtems/posix/time.h
index d00fc02491..f5e55a55be 100644
--- a/cpukit/posix/include/rtems/posix/time.h
+++ b/cpukit/posix/include/rtems/posix/time.h
@@ -24,7 +24,7 @@
/**
* @defgroup POSIX_TIMETYPES POSIX Time Types
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @{
*/
diff --git a/cpukit/posix/include/rtems/posix/timer.h b/cpukit/posix/include/rtems/posix/timer.h
index 544acd712a..0b70cc9950 100644
--- a/cpukit/posix/include/rtems/posix/timer.h
+++ b/cpukit/posix/include/rtems/posix/timer.h
@@ -24,12 +24,11 @@
#include <rtems/score/watchdog.h> /* Watchdog_Control */
/**
- * @defgroup POSIX_INTERNAL_TIMERS Timers
+ * @defgroup POSIX_INTERNAL_TIMERS POSIX Timer Private Support
*
- * @ingroup POSIX
- *
- * @{
+ * @ingroup POSIXAPI
*/
+/**@{*/
#ifdef __cplusplus
extern "C" {
@@ -38,13 +37,13 @@ extern "C" {
/* Timer is free */
#define POSIX_TIMER_STATE_FREE 0x01
-/* Created timer but not running */
+/* Created timer but not running */
#define POSIX_TIMER_STATE_CREATE_NEW 0x02
-/* Created timer and running */
+/* Created timer and running */
#define POSIX_TIMER_STATE_CREATE_RUN 0x03
-/* Created, ran and stopped timer */
+/* Created, ran and stopped timer */
#define POSIX_TIMER_STATE_CREATE_STOP 0x04
/* Indicates that the fire time is relative to the current one */
@@ -59,7 +58,6 @@ extern "C" {
#error "POSIX_TIMER_RELATIVE == TIMER_ABSTIME"
#endif
-
/*
* Data for a timer
*/
diff --git a/cpukit/posix/include/semaphore.h b/cpukit/posix/include/semaphore.h
index 65708c96f1..489258ecb0 100644
--- a/cpukit/posix/include/semaphore.h
+++ b/cpukit/posix/include/semaphore.h
@@ -26,7 +26,7 @@ extern "C" {
/**
* @defgroup POSIX_SEMAPHORE POSIX Semaphores Support
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief Private Support Information for POSIX Semaphores
*/