[rtems commit] posix: Doxygen Enhancement Task #10

Gedare Bloom gedare at rtems.org
Wed Dec 19 14:48:39 UTC 2012 

Module:    rtems
Branch:    master
Commit:    ab8721996a0b529adb629e602406bf54d387eb39
Changeset: http://git.rtems.org/rtems/commit/?id=ab8721996a0b529adb629e602406bf54d387eb39

Author:    Alex Ivanov <alexivanov97 at gmail.com>
Date:      Wed Dec 19 09:53:08 2012 -0500

posix: Doxygen Enhancement Task #10

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

---

 cpukit/posix/src/aio_write.c                   |    7 +++++++
 cpukit/posix/src/canceleval.c                  |    7 +++++++
 cpukit/posix/src/clockgetcpuclockid.c          |    7 +++++++
 cpukit/posix/src/getitimer.c                   |    7 +++++++
 cpukit/posix/src/mqueueclose.c                 |    7 +++++++
 cpukit/posix/src/mqueueopen.c                  |    7 +++++++
 cpukit/posix/src/mqueuetranslatereturncode.c   |    7 +++++++
 cpukit/posix/src/mutexattrsetpshared.c         |    7 +++++++
 cpukit/posix/src/pbarriertranslatereturncode.c |    7 +++++++
 cpukit/posix/src/prwlockunlock.c               |    7 +++++++
 cpukit/posix/src/pthreadattrgetdetachstate.c   |    7 +++++++
 cpukit/posix/src/pthreadattrsetscope.c         |    7 +++++++
 cpukit/posix/src/pthreadattrsetstack.c         |    7 +++++++
 cpukit/posix/src/pthreadgetschedparam.c        |    7 +++++++
 cpukit/posix/src/pthreadself.c                 |    7 +++++++
 cpukit/posix/src/pthreadsetschedparam.c        |    7 +++++++
 cpukit/posix/src/sigaddset.c                   |    7 +++++++
 cpukit/posix/src/sigwaitinfo.c                 |    6 ++++++
 cpukit/posix/src/testcancel.c                  |    7 +++++++
 cpukit/posix/src/timerinserthelper.c           |    7 +++++++
 20 files changed, 139 insertions(+), 0 deletions(-)

diff --git a/cpukit/posix/src/aio_write.c b/cpukit/posix/src/aio_write.c
index 7895c8c..a510946 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 at gmail.com> 
  * 
diff --git a/cpukit/posix/src/canceleval.c b/cpukit/posix/src/canceleval.c
index be74002..804efb4 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 8908ab6..fb04e17 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 316d43e..a7ee836 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 7fe1ceb..8492c90 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 b822978..d5f7839 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 b088eef..34edf80 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 6f9f9b4..87e8b52 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 b7d1999..e8a53ec 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 86f26d7..79042b2 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 e9b225d..bd23cb7 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 53a00a2..d468524 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 3eb4181..04231ed 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 5311e3f..8c78ccc 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 9400b4b..0ed68be 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 231b4f9..d574811 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 dac1cda..d4e324f 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 0b2045b..4538f5d 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 400ab7e..6228af6 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 9e2aa6a..a172677 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
  *

More information about the vc mailing list