posix: Doxygen Enhancement Task #11

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

20 files changed, 140 insertions, 0 deletions

diff --git a/cpukit/posix/src/aio_read.c b/cpukit/posix/src/aio_read.c
index 63bbac9c1b..f339752525 100644
--- a/cpukit/posix/src/aio_read.c
+++ b/cpukit/posix/src/aio_read.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Asynchronously reads Data from a File
+ * @ingroup POSIX
+ */
+
 /*
  * Copyright 2010, Alin Rus <alin.codejunkie@gmail.com> 
  * 
diff --git a/cpukit/posix/src/aio_suspend.c b/cpukit/posix/src/aio_suspend.c
index c42ee83be5..60c4af1389 100644
--- a/cpukit/posix/src/aio_suspend.c
+++ b/cpukit/posix/src/aio_suspend.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Suspends Process until Asynchronous I/O Operation completes
+ * @ingroup POSIX
+ */
+
 /*
  *  6.7.7 Wait for Asynchronous I/O Request, P1003.1b-1993, p. 164
  *
diff --git a/cpukit/posix/src/clockgettime.c b/cpukit/posix/src/clockgettime.c
index 2c5a9da5fa..46c1d46811 100644
--- a/cpukit/posix/src/clockgettime.c
+++ b/cpukit/posix/src/clockgettime.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Retrieves the Specified Clock Time
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/clocksetenableattr.c b/cpukit/posix/src/clocksetenableattr.c
index 9719147415..592b82341e 100644
--- a/cpukit/posix/src/clocksetenableattr.c
+++ b/cpukit/posix/src/clocksetenableattr.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Clock set Enable Attribute Access
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/condattrdestroy.c b/cpukit/posix/src/condattrdestroy.c
index 9f4a3949b6..6f686fe1df 100644
--- a/cpukit/posix/src/condattrdestroy.c
+++ b/cpukit/posix/src/condattrdestroy.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Destroy Condition Attribute
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/condattrinit.c b/cpukit/posix/src/condattrinit.c
index 83728bcdae..89b806cb7e 100644
--- a/cpukit/posix/src/condattrinit.c
+++ b/cpukit/posix/src/condattrinit.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Initialization of Conditional Attributes
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/keysetspecific.c b/cpukit/posix/src/keysetspecific.c
index 5b7fb8bc96..e631127fba 100644
--- a/cpukit/posix/src/keysetspecific.c
+++ b/cpukit/posix/src/keysetspecific.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Set Specific Key
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/mqueuetimedreceive.c b/cpukit/posix/src/mqueuetimedreceive.c
index ba79ce16d9..58f796160c 100644
--- a/cpukit/posix/src/mqueuetimedreceive.c
+++ b/cpukit/posix/src/mqueuetimedreceive.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Receive Message from 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/mutexattrgetprotocol.c b/cpukit/posix/src/mutexattrgetprotocol.c
index 584a38085b..1824b3fff9 100644
--- a/cpukit/posix/src/mutexattrgetprotocol.c
+++ b/cpukit/posix/src/mutexattrgetprotocol.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Get protocol Attribute of Mutex Attribute Obect
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/nanosleep.c b/cpukit/posix/src/nanosleep.c
index d97112605d..02abe55cec 100644
--- a/cpukit/posix/src/nanosleep.c
+++ b/cpukit/posix/src/nanosleep.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Suspends Execution of calling thread until Time elaps
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/prwlockwrlock.c b/cpukit/posix/src/prwlockwrlock.c
index fffdbea3a8..16e5ecd6f1 100644
--- a/cpukit/posix/src/prwlockwrlock.c
+++ b/cpukit/posix/src/prwlockwrlock.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Obtain a Write Lock on a RWlock Instance
+ * @ingroup POSIX
+ */
+
 /*
  *  POSIX RWLock Manager -- Obtain a Write Lock on a RWLock Instance
  *
diff --git a/cpukit/posix/src/psignalclearprocesssignals.c b/cpukit/posix/src/psignalclearprocesssignals.c
index 3c3cdf4e68..3d1d16b5aa 100644
--- a/cpukit/posix/src/psignalclearprocesssignals.c
+++ b/cpukit/posix/src/psignalclearprocesssignals.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief POSIX_signals clear_process_signals
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/pthreadattrsetschedpolicy.c b/cpukit/posix/src/pthreadattrsetschedpolicy.c
index e095d719b9..ee7fe1fce3 100644
--- a/cpukit/posix/src/pthreadattrsetschedpolicy.c
+++ b/cpukit/posix/src/pthreadattrsetschedpolicy.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Sets Scheduling policy 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/pthreadgetcpuclockid.c b/cpukit/posix/src/pthreadgetcpuclockid.c
index 51776f046e..0b7e3bbd28 100644
--- a/cpukit/posix/src/pthreadgetcpuclockid.c
+++ b/cpukit/posix/src/pthreadgetcpuclockid.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Returns Clock ID for CPU time clock of the thread 
+ * @ingroup POSIX
+ */
+
 /*
  *  20.1.6 Accessing a Thread CPU-time Clock, P1003.4b/Draft 8, p. 58
  *
diff --git a/cpukit/posix/src/pthreadkill.c b/cpukit/posix/src/pthreadkill.c
index 67ef0c7005..420aaa567f 100644
--- a/cpukit/posix/src/pthreadkill.c
+++ b/cpukit/posix/src/pthreadkill.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Sends a signal Asynchronously directed to a thread
+ * @ingroup POSIX
+ */
+
 /*
  *  3.3.10 Send a Signal to a Thread, P1003.1c/D10, p. 43
  *
diff --git a/cpukit/posix/src/rwlockattrsetpshared.c b/cpukit/posix/src/rwlockattrsetpshared.c
index f27a5b56fe..5a32530e1e 100644
--- a/cpukit/posix/src/rwlockattrsetpshared.c
+++ b/cpukit/posix/src/rwlockattrsetpshared.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RWLock Attributes Set Process Shared
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/sched_getprioritymax.c b/cpukit/posix/src/sched_getprioritymax.c
index a85f02b250..5a77e258f1 100644
--- a/cpukit/posix/src/sched_getprioritymax.c
+++ b/cpukit/posix/src/sched_getprioritymax.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Returns the Appropriate Maximum for Scheduling policy
+ * @ingroup POSIX
+ */
+
 /*
  *  13.3.6 Get Scheduling Parameter Limits, P1003.1b-1993, p. 258
  *
diff --git a/cpukit/posix/src/sigdelset.c b/cpukit/posix/src/sigdelset.c
index a559e64bbb..7567689ccd 100644
--- a/cpukit/posix/src/sigdelset.c
+++ b/cpukit/posix/src/sigdelset.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Deleted Signal from Set
+ * @ingroup POSIX
+ */
+
 /*
  *  3.3.3 Manipulate Signal Sets, P1003.1b-1993, p. 69
  *
diff --git a/cpukit/posix/src/timerdelete.c b/cpukit/posix/src/timerdelete.c
index 89cfe2f056..473c0df3fe 100644
--- a/cpukit/posix/src/timerdelete.c
+++ b/cpukit/posix/src/timerdelete.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Deletes a POSIX Interval Timer
+ * @ingroup POSIX
+ */
+
 /*
  *  14.2.3 Delete a Per_process Timer, P1003.1b-1993, p. 266
  *
diff --git a/cpukit/posix/src/vfork.c b/cpukit/posix/src/vfork.c
index 64838c8d87..3bb0f31b83 100644
--- a/cpukit/posix/src/vfork.c
+++ b/cpukit/posix/src/vfork.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Creates Child process Of The Calling process
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).