posix: Doxygen Enhancement Task #10

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

20 files changed, 139 insertions, 0 deletions

diff --git a/cpukit/posix/src/aio_write.c b/cpukit/posix/src/aio_write.c
index 7895c8c218..a510946837 100644
--- a/cpukit/posix/src/aio_write.c
+++ b/cpukit/posix/src/aio_write.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function queues I/O request described by buffer pointed by aiocb 
+ * @ingroup POSIX
+ */
+
 /*
  * Copyright 2010, Alin Rus <alin.codejunkie@gmail.com> 
  * 
diff --git a/cpukit/posix/src/canceleval.c b/cpukit/posix/src/canceleval.c
index be7400289c..804efb4726 100644
--- a/cpukit/posix/src/canceleval.c
+++ b/cpukit/posix/src/canceleval.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief POSIX Function Evaluates Thread Cancellation and Enables Dispatch
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2009.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/clockgetcpuclockid.c b/cpukit/posix/src/clockgetcpuclockid.c
index 8908ab6801..fb04e174aa 100644
--- a/cpukit/posix/src/clockgetcpuclockid.c
+++ b/cpukit/posix/src/clockgetcpuclockid.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function Returns Clock ID of CPU-time Clock of process specified 
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/getitimer.c b/cpukit/posix/src/getitimer.c
index 316d43ea77..a7ee836b04 100644
--- a/cpukit/posix/src/getitimer.c
+++ b/cpukit/posix/src/getitimer.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function Gets Value of an Interval Timer
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-20089
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/mqueueclose.c b/cpukit/posix/src/mqueueclose.c
index 7fe1cebd33..8492c90705 100644
--- a/cpukit/posix/src/mqueueclose.c
+++ b/cpukit/posix/src/mqueueclose.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function closes the Message Queue 
+ * @ingroup POSIX
+ */
+
 /*
  *  NOTE:  The structure of the routines is identical to that of POSIX
  *         Message_queues to leave the option of having unnamed message
diff --git a/cpukit/posix/src/mqueueopen.c b/cpukit/posix/src/mqueueopen.c
index b822978bc9..d5f783990e 100644
--- a/cpukit/posix/src/mqueueopen.c
+++ b/cpukit/posix/src/mqueueopen.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Creates a new POSIX Message Queue or Opens an Existing Queue 
+ * @ingroup POSIX
+ */
+
 /*
  *  NOTE:  The structure of the routines is identical to that of POSIX
  *         Message_queues to leave the option of having unnamed message
diff --git a/cpukit/posix/src/mqueuetranslatereturncode.c b/cpukit/posix/src/mqueuetranslatereturncode.c
index b088eef179..34edf80a24 100644
--- a/cpukit/posix/src/mqueuetranslatereturncode.c
+++ b/cpukit/posix/src/mqueuetranslatereturncode.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief POSIX Error Translation in Message Queue
+ * @ingroup POSIX
+ */
+
 /*
  *  POSIX Message Queue Error Translation
  *
diff --git a/cpukit/posix/src/mutexattrsetpshared.c b/cpukit/posix/src/mutexattrsetpshared.c
index 6f9f9b4f9a..87e8b52f2b 100644
--- a/cpukit/posix/src/mutexattrsetpshared.c
+++ b/cpukit/posix/src/mutexattrsetpshared.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function sets Current pshared Attribute for Mutex Attributes Object
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/pbarriertranslatereturncode.c b/cpukit/posix/src/pbarriertranslatereturncode.c
index b7d1999d93..e8a53ec459 100644
--- a/cpukit/posix/src/pbarriertranslatereturncode.c
+++ b/cpukit/posix/src/pbarriertranslatereturncode.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function Translates POSIX Barrier Status Code
+ * @ingroup POSIX
+ */
+
 /*
  *  Barrier Manager -- Translate SuperCore Status
  *
diff --git a/cpukit/posix/src/prwlockunlock.c b/cpukit/posix/src/prwlockunlock.c
index 86f26d7a23..79042b259d 100644
--- a/cpukit/posix/src/prwlockunlock.c
+++ b/cpukit/posix/src/prwlockunlock.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function Releases a lock held on RWLock object referenced by rwlock 
+ * @ingroup POSIX
+ */
+
 /*
  *  POSIX RWLock Manager -- Release a lock held on a RWLock Instance
  *
diff --git a/cpukit/posix/src/pthreadattrgetdetachstate.c b/cpukit/posix/src/pthreadattrgetdetachstate.c
index e9b225d23c..bd23cb7f30 100644
--- a/cpukit/posix/src/pthreadattrgetdetachstate.c
+++ b/cpukit/posix/src/pthreadattrgetdetachstate.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function gets the detachstate 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/pthreadattrsetscope.c b/cpukit/posix/src/pthreadattrsetscope.c
index 53a00a268b..d468524086 100644
--- a/cpukit/posix/src/pthreadattrsetscope.c
+++ b/cpukit/posix/src/pthreadattrsetscope.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function Sets the Contentionscope Attribute in the attr Object
+ * @ingroup POSIX
+ */
+
 /*
  *  13.5.1 Thread Creation Scheduling Attributes, P1003.1c/Draft 10, p. 120
  *
diff --git a/cpukit/posix/src/pthreadattrsetstack.c b/cpukit/posix/src/pthreadattrsetstack.c
index 3eb4181842..04231ed791 100644
--- a/cpukit/posix/src/pthreadattrsetstack.c
+++ b/cpukit/posix/src/pthreadattrsetstack.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function Sets Thread Creation Stack Attributes in the attr object
+ * @ingroup POSIX
+ */
+
 /*
  *  16.1.1 Thread Creation Attributes
  *
diff --git a/cpukit/posix/src/pthreadgetschedparam.c b/cpukit/posix/src/pthreadgetschedparam.c
index 5311e3f5e0..8c78ccca52 100644
--- a/cpukit/posix/src/pthreadgetschedparam.c
+++ b/cpukit/posix/src/pthreadgetschedparam.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Gets Scheduling Policy and Parameters of Individual Threads
+ * @ingroup POSIX
+ */
+
 /*
  *  13.5.2 Dynamic Thread Scheduling Parameters Access,
  *         P1003.1c/Draft 10, p. 124
diff --git a/cpukit/posix/src/pthreadself.c b/cpukit/posix/src/pthreadself.c
index 9400b4b7fe..0ed68be515 100644
--- a/cpukit/posix/src/pthreadself.c
+++ b/cpukit/posix/src/pthreadself.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function returns the ID of the Calling Thread 
+ * @ingroup POSIX
+ */
+
 /*
  *  16.1.6 Get Calling Thread's ID, p1003.1c/Draft 10, p. 152
  *
diff --git a/cpukit/posix/src/pthreadsetschedparam.c b/cpukit/posix/src/pthreadsetschedparam.c
index 231b4f930f..d574811ae0 100644
--- a/cpukit/posix/src/pthreadsetschedparam.c
+++ b/cpukit/posix/src/pthreadsetschedparam.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function sets scheduling policy and parameters of the thread
+ * @ingroup POSIX
+ */
+
 /*
  *  13.5.2 Dynamic Thread Scheduling Parameters Access,
  *         P1003.1c/Draft 10, p. 124
diff --git a/cpukit/posix/src/sigaddset.c b/cpukit/posix/src/sigaddset.c
index dac1cda520..d4e324fe5e 100644
--- a/cpukit/posix/src/sigaddset.c
+++ b/cpukit/posix/src/sigaddset.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function Adds Signal from Set
+ * @ingroup POSIX
+ */
+
 /*
  *  3.3.3 Manipulate Signal Sets, P1003.1b-1993, p. 69
  *
diff --git a/cpukit/posix/src/sigwaitinfo.c b/cpukit/posix/src/sigwaitinfo.c
index 0b2045bcad..4538f5df07 100644
--- a/cpukit/posix/src/sigwaitinfo.c
+++ b/cpukit/posix/src/sigwaitinfo.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Suspends Execution of Calling Thread until Signals in set Deleivered
+ */
+
 /*
  *  3.3.8 Synchronously Accept a Signal, P1003.1b-1993, p. 76
  *
diff --git a/cpukit/posix/src/testcancel.c b/cpukit/posix/src/testcancel.c
index 400ab7efe5..6228af6165 100644
--- a/cpukit/posix/src/testcancel.c
+++ b/cpukit/posix/src/testcancel.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Setting test on Cancelability State 
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/timerinserthelper.c b/cpukit/posix/src/timerinserthelper.c
index 9e2aa6a437..a1726770d9 100644
--- a/cpukit/posix/src/timerinserthelper.c
+++ b/cpukit/posix/src/timerinserthelper.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Helper Routine for POSIX TIMERS 
+ * @ingroup POSIX
+ */
+
 /*
  *  Helper routine for POSIX timers
  *