posix: Doxygen Enhancement Task #9

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

20 files changed, 140 insertions, 0 deletions

diff --git a/cpukit/posix/src/aio_misc.c b/cpukit/posix/src/aio_misc.c
index 80e95636ad..12bec2eb7d 100644
--- a/cpukit/posix/src/aio_misc.c
+++ b/cpukit/posix/src/aio_misc.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Actual request being processed
+ * @ingroup POSIX
+ */
+
 /*
  * Copyright 2010-2011, Alin Rus <alin.codejunkie@gmail.com> 
  * 
diff --git a/cpukit/posix/src/aio_return.c b/cpukit/posix/src/aio_return.c
index da10ebffa6..87c3af1f3e 100644
--- a/cpukit/posix/src/aio_return.c
+++ b/cpukit/posix/src/aio_return.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Final return status for Asynchronous I/O request pointed to by aiobcp
+ * @ingroup POSIX
+ */
+
 /*
  * Copyright 2010, Alin Rus <alin.codejunkie@gmail.com> 
  * 
diff --git a/cpukit/posix/src/alarm.c b/cpukit/posix/src/alarm.c
index b3c902cbab..22ffcae5c3 100644
--- a/cpukit/posix/src/alarm.c
+++ b/cpukit/posix/src/alarm.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief System Generates Signal for process after realtime seconds elapsed
+ * @ingroup POSIX
+ */
+
 /*
  *  3.4.1 Schedule Alarm, P1003.1b-1993, p. 79
  */
diff --git a/cpukit/posix/src/barrierattrdestroy.c b/cpukit/posix/src/barrierattrdestroy.c
index f8c1a99355..c0a6fada2c 100644
--- a/cpukit/posix/src/barrierattrdestroy.c
+++ b/cpukit/posix/src/barrierattrdestroy.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function shall Destroy a Barrier Attribues Object
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/clockgetenableattr.c b/cpukit/posix/src/clockgetenableattr.c
index 7d7bf895cb..8420c2be88 100644
--- a/cpukit/posix/src/clockgetenableattr.c
+++ b/cpukit/posix/src/clockgetenableattr.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Clock get Enable Attribute Access
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/clockgetres.c b/cpukit/posix/src/clockgetres.c
index 623fa2433a..60d516d26e 100644
--- a/cpukit/posix/src/clockgetres.c
+++ b/cpukit/posix/src/clockgetres.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function Returns the Resolution of any Clock
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/execv.c b/cpukit/posix/src/execv.c
index 8c56274698..26d62b123d 100644
--- a/cpukit/posix/src/execv.c
+++ b/cpukit/posix/src/execv.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Inoperable implementation of execv for POSIX threads
+ * @ingroup POSIX
+ */
+
 /*
  *  execv() - POSIX 1003.1b 3.1.2
  *
diff --git a/cpukit/posix/src/keydelete.c b/cpukit/posix/src/keydelete.c
index b0b5daa3be..41d57772bf 100644
--- a/cpukit/posix/src/keydelete.c
+++ b/cpukit/posix/src/keydelete.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Deletes Thread-specific Data Key Previously Returned by keycreate.c
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/mqueuesendsupp.c b/cpukit/posix/src/mqueuesendsupp.c
index dc70c471e0..3fbe0fb164 100644
--- a/cpukit/posix/src/mqueuesendsupp.c
+++ b/cpukit/posix/src/mqueuesendsupp.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief POSIX Message Queue and Send Support
+ * @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/mutexattrgettype.c b/cpukit/posix/src/mutexattrgettype.c
index 23d0bb875f..9137271d9d 100644
--- a/cpukit/posix/src/mutexattrgettype.c
+++ b/cpukit/posix/src/mutexattrgettype.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function gets the Mutex Type Attribute
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2009.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/mutexlock.c b/cpukit/posix/src/mutexlock.c
index 0e3125f06f..be5e4d56df 100644
--- a/cpukit/posix/src/mutexlock.c
+++ b/cpukit/posix/src/mutexlock.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Call to function enables locking of Mutex Object referenced by mutex
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/pbarrierinit.c b/cpukit/posix/src/pbarrierinit.c
index 077d63289c..c3077cb903 100644
--- a/cpukit/posix/src/pbarrierinit.c
+++ b/cpukit/posix/src/pbarrierinit.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Call to Function Enables Reinitializing of the Barrier
+ * @ingroup POSIX
+ */
+
 /*
  *  POSIX Barrier Manager -- Initialize a Barrier Instance
  *
diff --git a/cpukit/posix/src/pspininit.c b/cpukit/posix/src/pspininit.c
index 4a1019abaa..030bb50ae2 100644
--- a/cpukit/posix/src/pspininit.c
+++ b/cpukit/posix/src/pspininit.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief POSIX Function Initializes a Spinlock Instance
+ * @ingroup POSIX
+ */
+
 /*
  *  POSIX Spinlock Manager -- Initialize a Spinlock Instance
  *
diff --git a/cpukit/posix/src/pthreadattrsetinheritsched.c b/cpukit/posix/src/pthreadattrsetinheritsched.c
index 65c43dd24a..2951444fcf 100644
--- a/cpukit/posix/src/pthreadattrsetinheritsched.c
+++ b/cpukit/posix/src/pthreadattrsetinheritsched.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function sets the inheritsched Attribute in the attr Argument
+ * @ingroup POSIX
+ */
+
 /*
  *  13.5.1 Thread Creation Scheduling Attributes, P1003.1c/Draft 10, p. 120
  *
diff --git a/cpukit/posix/src/pthreadcreate.c b/cpukit/posix/src/pthreadcreate.c
index c320f40660..30551ac64c 100644
--- a/cpukit/posix/src/pthreadcreate.c
+++ b/cpukit/posix/src/pthreadcreate.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function Starts a New Thread in The Calling Process
+ * @ingroup POSIX
+ */
+
 /*
  *  16.1.2 Thread Creation, P1003.1c/Draft 10, p. 144
  */
diff --git a/cpukit/posix/src/rwlockattrinit.c b/cpukit/posix/src/rwlockattrinit.c
index ea88e002b2..381cd52b0d 100644
--- a/cpukit/posix/src/rwlockattrinit.c
+++ b/cpukit/posix/src/rwlockattrinit.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Initialises a RWLock Attributes object attr with the default value
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/sched_getscheduler.c b/cpukit/posix/src/sched_getscheduler.c
index 755b38e2a6..6f12cd7868 100644
--- a/cpukit/posix/src/sched_getscheduler.c
+++ b/cpukit/posix/src/sched_getscheduler.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function Returns Scheduling Policy of the process specified by pid
+ * @ingroup POSIX
+ */
+
 /*
  *  13.3.4 Get Scheduling Policy, P1003.1b-1993, p. 256
  *
diff --git a/cpukit/posix/src/semaphore.c b/cpukit/posix/src/semaphore.c
index a64fe81206..b214a3c302 100644
--- a/cpukit/posix/src/semaphore.c
+++ b/cpukit/posix/src/semaphore.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief POSIX Function Initializes Semaphore Manager
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/semopen.c b/cpukit/posix/src/semopen.c
index 3354369936..1ecd75105b 100644
--- a/cpukit/posix/src/semopen.c
+++ b/cpukit/posix/src/semopen.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function Creates New POSIX semaphore or Opens an existing Semaphore
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/sigsuspend.c b/cpukit/posix/src/sigsuspend.c
index f84d11f119..b1f1c4cc77 100644
--- a/cpukit/posix/src/sigsuspend.c
+++ b/cpukit/posix/src/sigsuspend.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Replacing signal mask with *sigmask and suspending calling process
+ * @ingroup POSIX
+ */
+
 /*
  *  3.3.7 Wait for a Signal, P1003.1b-1993, p. 75
  *