[rtems commit] posix: Doxygen Enhancement Task #6
Gedare Bloom
gedare at rtems.org
Thu Dec 20 03:19:28 UTC 2012
Module: rtems
Branch: master
Commit: 1be3fad9b473831c83ef2ded0125d402880b7e45
Changeset: http://git.rtems.org/rtems/commit/?id=1be3fad9b473831c83ef2ded0125d402880b7e45
Author: Ayush Awasthi <kolaveridi87 at gmail.com>
Date: Wed Dec 19 22:23:52 2012 -0500
posix: Doxygen Enhancement Task #6
http://www.google-melange.com/gci/task/view/google/gci2012/7945218
---
cpukit/posix/src/cleanuppop.c | 7 +++++++
cpukit/posix/src/execl.c | 7 +++++++
cpukit/posix/src/keyfreememory.c | 7 +++++++
cpukit/posix/src/lio_listio.c | 7 +++++++
cpukit/posix/src/mqueuesend.c | 7 +++++++
cpukit/posix/src/mutexlocksupp.c | 7 +++++++
cpukit/posix/src/prwlocktimedwrlock.c | 7 +++++++
cpukit/posix/src/pspinunlock.c | 7 +++++++
cpukit/posix/src/pthreadattrgetscope.c | 7 +++++++
cpukit/posix/src/pthreadattrgetstack.c | 7 +++++++
cpukit/posix/src/pthreadattrsetstacksize.c | 7 +++++++
cpukit/posix/src/pthreadjoin.c | 7 +++++++
cpukit/posix/src/pthreadonce.c | 7 +++++++
cpukit/posix/src/rwlockattrdestroy.c | 7 +++++++
cpukit/posix/src/sched_setparam.c | 7 +++++++
cpukit/posix/src/semaphorecreatesupp.c | 7 +++++++
cpukit/posix/src/setcanceltype.c | 7 +++++++
cpukit/posix/src/signal_2.c | 7 +++++++
cpukit/posix/src/timergettime.c | 7 +++++++
cpukit/posix/src/timersettime.c | 7 +++++++
20 files changed, 140 insertions(+), 0 deletions(-)
diff --git a/cpukit/posix/src/cleanuppop.c b/cpukit/posix/src/cleanuppop.c
index 06e5650..9e198f7 100644
--- a/cpukit/posix/src/cleanuppop.c
+++ b/cpukit/posix/src/cleanuppop.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Removes Routine from Top of Calling Thread's stack and Invoke it
+ * @ingroup POSIX
+ */
+
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/execl.c b/cpukit/posix/src/execl.c
index d329e5f..61b9a74 100644
--- a/cpukit/posix/src/execl.c
+++ b/cpukit/posix/src/execl.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Process will get Executed and then Terminated by execl
+ * @ingroup POSIX
+ */
+
/*
* execl() - POSIX 1003.1b 3.1.2
*
diff --git a/cpukit/posix/src/keyfreememory.c b/cpukit/posix/src/keyfreememory.c
index d5ef5ee..35e8a36 100644
--- a/cpukit/posix/src/keyfreememory.c
+++ b/cpukit/posix/src/keyfreememory.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief POSIX Function Keys Free Memory
+ * @ingroup POSIX
+ */
+
/*
* COPYRIGHT (c) 1989-2010.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/lio_listio.c b/cpukit/posix/src/lio_listio.c
index 235e689..9b53b4d 100644
--- a/cpukit/posix/src/lio_listio.c
+++ b/cpukit/posix/src/lio_listio.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function Initiates a List of I/O Requests with Single Function Call
+ * @ingroup POSIX
+ */
+
/*
* 6.7.4 List Directed I/O, P1003.1b-1993, p. 158
*
diff --git a/cpukit/posix/src/mqueuesend.c b/cpukit/posix/src/mqueuesend.c
index 9448dbb..0d67b6d 100644
--- a/cpukit/posix/src/mqueuesend.c
+++ b/cpukit/posix/src/mqueuesend.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Adds Message Pointed by msg_ptr to Message Queue Reffered by mqdes
+ * @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/mutexlocksupp.c b/cpukit/posix/src/mutexlocksupp.c
index 299aaa1..6b5d7bd 100644
--- a/cpukit/posix/src/mutexlocksupp.c
+++ b/cpukit/posix/src/mutexlocksupp.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Support Call to function Enables Locking of Mutex Object
+ * @ingroup POSIX
+ */
+
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/prwlocktimedwrlock.c b/cpukit/posix/src/prwlocktimedwrlock.c
index 5e6e4ba..ca43537 100644
--- a/cpukit/posix/src/prwlocktimedwrlock.c
+++ b/cpukit/posix/src/prwlocktimedwrlock.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function applies a Write lock to RWLock referenced by rwlock
+ * @ingroup POSIX
+ */
+
/*
* POSIX RWLock Manager -- Attempt to Obtain a Write Lock on a RWLock Instance
*
diff --git a/cpukit/posix/src/pspinunlock.c b/cpukit/posix/src/pspinunlock.c
index 4fb1391..67a69cb 100644
--- a/cpukit/posix/src/pspinunlock.c
+++ b/cpukit/posix/src/pspinunlock.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function Unlocks a Spin Lock Object
+ * @ingroup POSIX
+ */
+
/*
* POSIX Spinlock Manager -- Wait at a Spinlock
*
diff --git a/cpukit/posix/src/pthreadattrgetscope.c b/cpukit/posix/src/pthreadattrgetscope.c
index e7eb7f8..ee5ed4c 100644
--- a/cpukit/posix/src/pthreadattrgetscope.c
+++ b/cpukit/posix/src/pthreadattrgetscope.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function gets 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/pthreadattrgetstack.c b/cpukit/posix/src/pthreadattrgetstack.c
index e035ee4..a1254ae 100644
--- a/cpukit/posix/src/pthreadattrgetstack.c
+++ b/cpukit/posix/src/pthreadattrgetstack.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function Gets the Thread Creation Stack Attributes in the attr
+ * @ingroup POSIX
+ */
+
/*
* 16.1.1 Thread Creation Attributes
*
diff --git a/cpukit/posix/src/pthreadattrsetstacksize.c b/cpukit/posix/src/pthreadattrsetstacksize.c
index d6a2050..eb269e3 100644
--- a/cpukit/posix/src/pthreadattrsetstacksize.c
+++ b/cpukit/posix/src/pthreadattrsetstacksize.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Sets the Thread Creation Stacksize 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/pthreadjoin.c b/cpukit/posix/src/pthreadjoin.c
index ac48612..115f39d 100644
--- a/cpukit/posix/src/pthreadjoin.c
+++ b/cpukit/posix/src/pthreadjoin.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Suspends Execution of Calling Thread until Target Thread Terminates
+ * @ingroup POSIX
+ */
+
/*
* 16.1.3 Wait for Thread Termination, P1003.1c/Draft 10, p. 147
*
diff --git a/cpukit/posix/src/pthreadonce.c b/cpukit/posix/src/pthreadonce.c
index 5f598a7..651e4d0 100644
--- a/cpukit/posix/src/pthreadonce.c
+++ b/cpukit/posix/src/pthreadonce.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Call to function by Thread will call init_routine with no Arguments
+ * @ingroup POSIX
+ */
+
/*
* 16.1.8 Dynamic Package Initialization, P1003.1c/Draft 10, p. 154
*
diff --git a/cpukit/posix/src/rwlockattrdestroy.c b/cpukit/posix/src/rwlockattrdestroy.c
index 022fe79..102b141 100644
--- a/cpukit/posix/src/rwlockattrdestroy.c
+++ b/cpukit/posix/src/rwlockattrdestroy.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function Destroys a read-write lock Attributes object
+ * @ingroup POSIX
+ */
+
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/sched_setparam.c b/cpukit/posix/src/sched_setparam.c
index d31a29f..8e894e0 100644
--- a/cpukit/posix/src/sched_setparam.c
+++ b/cpukit/posix/src/sched_setparam.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Sets Scheduling Parameters Associated with Scheduling Policies
+ * @ingroup POSIX
+ */
+
/*
* 13.3.1 Set Scheduling Parameters, P1003.1b-1993, p. 252
*
diff --git a/cpukit/posix/src/semaphorecreatesupp.c b/cpukit/posix/src/semaphorecreatesupp.c
index 6460da8..18fef72 100644
--- a/cpukit/posix/src/semaphorecreatesupp.c
+++ b/cpukit/posix/src/semaphorecreatesupp.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function does Actual creation and Initialization of POSIX Semaphore
+ * @ingroup POSIX
+ */
+
/*
* COPYRIGHT (c) 1989-2009.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/setcanceltype.c b/cpukit/posix/src/setcanceltype.c
index c0278dd..6a82374 100644
--- a/cpukit/posix/src/setcanceltype.c
+++ b/cpukit/posix/src/setcanceltype.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Sets the Cancelability Type of Calling Thread to value given in type
+ * @ingroup POSIX
+ */
+
/*
* COPYRIGHT (c) 1989-2009.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/signal_2.c b/cpukit/posix/src/signal_2.c
index b1bf93c..75f13d8 100644
--- a/cpukit/posix/src/signal_2.c
+++ b/cpukit/posix/src/signal_2.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief POSIX Function Installs signal Handler
+ * @ingroup POSIX
+ */
+
/*
* signal(2) - Install signal handler
*
diff --git a/cpukit/posix/src/timergettime.c b/cpukit/posix/src/timergettime.c
index 3aa63e3..823989a 100644
--- a/cpukit/posix/src/timergettime.c
+++ b/cpukit/posix/src/timergettime.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function Fetches State of POSIX Per-Process Timers
+ * @ingroup POSIX
+ */
+
/*
* 14.2.4 Per-Process Timers, P1003.1b-1993, p. 267
*
diff --git a/cpukit/posix/src/timersettime.c b/cpukit/posix/src/timersettime.c
index b0c3061..00cce57 100644
--- a/cpukit/posix/src/timersettime.c
+++ b/cpukit/posix/src/timersettime.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Function Arms or Disarms the Timer Identified by timerid
+ * @ingroup POSIX
+ */
+
/*
* 14.2.4 Per-Process Timers, P1003.1b-1993, p. 267
*
More information about the vc
mailing list