posix: Doxygen Enhancement Task #3

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

20 files changed, 140 insertions, 0 deletions

diff --git a/cpukit/posix/src/aio_error.c b/cpukit/posix/src/aio_error.c
index 1765f21622..e29c8361b1 100644
--- a/cpukit/posix/src/aio_error.c
+++ b/cpukit/posix/src/aio_error.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Returns the error status for the Asynchronous I/O request
+ * @ingroup POSIX
+ */
+
 /*
  * Copyright 2010, Alin Rus <alin.codejunkie@gmail.com> 
  * 
diff --git a/cpukit/posix/src/aio_fsync.c b/cpukit/posix/src/aio_fsync.c
index 7021082930..0330076696 100644
--- a/cpukit/posix/src/aio_fsync.c
+++ b/cpukit/posix/src/aio_fsync.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Syncing of all Outstanding Asynchronous I/O Operations
+ * @ingroup POSIX
+ */
+
 /*
  * Copyright 2010, Alin Rus <alin.codejunkie@gmail.com> 
  * 
diff --git a/cpukit/posix/src/cancelrun.c b/cpukit/posix/src/cancelrun.c
index 91749281d8..39a8de763d 100644
--- a/cpukit/posix/src/cancelrun.c
+++ b/cpukit/posix/src/cancelrun.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Executes a thread's cancellation handlers
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/condattrsetpshared.c b/cpukit/posix/src/condattrsetpshared.c
index f010038cbc..4e00c920c5 100644
--- a/cpukit/posix/src/condattrsetpshared.c
+++ b/cpukit/posix/src/condattrsetpshared.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Initialize Condition Variable Attributes
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/conddefaultattributes.c b/cpukit/posix/src/conddefaultattributes.c
index 7cca0bcb64..32ec64d69a 100644
--- a/cpukit/posix/src/conddefaultattributes.c
+++ b/cpukit/posix/src/conddefaultattributes.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Condition variable Attributes structure
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/fork.c b/cpukit/posix/src/fork.c
index ec24f051d7..4cfccf4a02 100644
--- a/cpukit/posix/src/fork.c
+++ b/cpukit/posix/src/fork.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Inoperable implementation of fork() for POSIX threads
+ * @ingroup POSIX
+ */
+
 /*
  *  fork() - POSIX 1003.1b 3.1.1
  *
diff --git a/cpukit/posix/src/kill_r.c b/cpukit/posix/src/kill_r.c
index 301c0603cf..739fed7358 100644
--- a/cpukit/posix/src/kill_r.c
+++ b/cpukit/posix/src/kill_r.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Send a Signal to a Process
+ * @ingroup POSIX
+ */
+
 /*
  *  3.3.2 Send a Signal to a Process, P1003.1b-1993, p. 68
  *
diff --git a/cpukit/posix/src/killinfo.c b/cpukit/posix/src/killinfo.c
index 95a2459100..b7b556de39 100644
--- a/cpukit/posix/src/killinfo.c
+++ b/cpukit/posix/src/killinfo.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Send a Signal to a Process
+ * @ingroup POSIX
+ */
+
 /*
  *  kill() support routine
  *
diff --git a/cpukit/posix/src/mutexattrgetpshared.c b/cpukit/posix/src/mutexattrgetpshared.c
index beeae9bc87..d32ef838b6 100644
--- a/cpukit/posix/src/mutexattrgetpshared.c
+++ b/cpukit/posix/src/mutexattrgetpshared.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Obtaining process-shared Attribute Value from the Attributes Object
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/mutexgetprioceiling.c b/cpukit/posix/src/mutexgetprioceiling.c
index a0390b99f5..21287e2c38 100644
--- a/cpukit/posix/src/mutexgetprioceiling.c
+++ b/cpukit/posix/src/mutexgetprioceiling.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Returns the Current Priority Ceiling of the Mutex
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/mutexsetprioceiling.c b/cpukit/posix/src/mutexsetprioceiling.c
index d873805e21..b11c4570ab 100644
--- a/cpukit/posix/src/mutexsetprioceiling.c
+++ b/cpukit/posix/src/mutexsetprioceiling.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Changes the Priority Ceiling of a Mutex and Releases it
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2009.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/prwlockinit.c b/cpukit/posix/src/prwlockinit.c
index 2cba7d66aa..61825fe1d5 100644
--- a/cpukit/posix/src/prwlockinit.c
+++ b/cpukit/posix/src/prwlockinit.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Allocate resources to use the read-write lock and Initialize it
+ * @ingroup POSIX
+ */
+
 /*
  *  POSIX RWLock Manager -- Destroy a RWLock Instance
  *
diff --git a/cpukit/posix/src/pthreadattrgetschedparam.c b/cpukit/posix/src/pthreadattrgetschedparam.c
index 7ec55a305d..eee962f854 100644
--- a/cpukit/posix/src/pthreadattrgetschedparam.c
+++ b/cpukit/posix/src/pthreadattrgetschedparam.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Returns Scheduling Parameter Attributes of Thread Attributes Object
+ * @ingroup POSIX
+ */
+
 /*
  *  13.5.1 Thread Creation Scheduling Attributes, P1003.1c/Draft 10, p. 120
  *
diff --git a/cpukit/posix/src/pthreadattrsetstackaddr.c b/cpukit/posix/src/pthreadattrsetstackaddr.c
index 3c3b2b05d3..1696bb95ac 100644
--- a/cpukit/posix/src/pthreadattrsetstackaddr.c
+++ b/cpukit/posix/src/pthreadattrsetstackaddr.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Sets the Thread Creation stackaddr Attribute in the attr Object
+ * @ingroup POSIX
+ */
+
 /*
  *  16.1.1 Thread Creation Attributes, P1003.1c/Draft 10, p, 140
  *
diff --git a/cpukit/posix/src/pthreadsigmask.c b/cpukit/posix/src/pthreadsigmask.c
index b424daba78..9d47e44865 100644
--- a/cpukit/posix/src/pthreadsigmask.c
+++ b/cpukit/posix/src/pthreadsigmask.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Examine and/or change the calling thread's signal mask
+ * @ingroup POSIX
+ */
+
 /*
  *  3.3.5 Examine and Change Blocked Signals, P1003.1b-1993, p. 73
  *
diff --git a/cpukit/posix/src/ptimer.c b/cpukit/posix/src/ptimer.c
index 2e3526730a..1d5ac6245e 100644
--- a/cpukit/posix/src/ptimer.c
+++ b/cpukit/posix/src/ptimer.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Process Timer
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/sched_rr_get_interval.c b/cpukit/posix/src/sched_rr_get_interval.c
index 5fb2774ccf..b73f60f229 100644
--- a/cpukit/posix/src/sched_rr_get_interval.c
+++ b/cpukit/posix/src/sched_rr_get_interval.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Limits for Scheduling Parameter
+ * @ingroup POSIX
+ */
+
 /*
  *  13.3.6 Get Scheduling Parameter Limits, P1003.1b-1993, p. 258
  *
diff --git a/cpukit/posix/src/semaphoretranslatereturncode.c b/cpukit/posix/src/semaphoretranslatereturncode.c
index 2f1af1dd1b..2c54b9fb49 100644
--- a/cpukit/posix/src/semaphoretranslatereturncode.c
+++ b/cpukit/posix/src/semaphoretranslatereturncode.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief POSIX Semaphore Code Translation Error
+ * @ingroup POSIX
+ */
+
 /*
  *  POSIX Semaphore Error Translation
  *
diff --git a/cpukit/posix/src/seminit.c b/cpukit/posix/src/seminit.c
index 42dd0405d1..be7056dcad 100644
--- a/cpukit/posix/src/seminit.c
+++ b/cpukit/posix/src/seminit.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Initializing of an Unnamed Semaphore
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/sigaction.c b/cpukit/posix/src/sigaction.c
index 9fb04a042d..b2906558e0 100644
--- a/cpukit/posix/src/sigaction.c
+++ b/cpukit/posix/src/sigaction.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Allows calling process to examine action of a Specific Signal
+ * @ingroup POSIX
+ */
+
 /*
  *  3.3.4 Examine and Change Signal Action, P1003.1b-1993, p. 70
  *