[rtems commit] posix: Doxygen Enhancement Task #11

Gedare Bloom gedare at rtems.org
Tue Dec 18 20:38:02 UTC 2012 

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

Author:    Ayush Awasthi <kolaveridi87 at gmail.com>
Date:      Tue Dec 18 15:42:30 2012 -0500

posix: Doxygen Enhancement Task #11

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

---

 cpukit/posix/src/aio_read.c                   |    7 +++++++
 cpukit/posix/src/aio_suspend.c                |    7 +++++++
 cpukit/posix/src/clockgettime.c               |    7 +++++++
 cpukit/posix/src/clocksetenableattr.c         |    7 +++++++
 cpukit/posix/src/condattrdestroy.c            |    7 +++++++
 cpukit/posix/src/condattrinit.c               |    7 +++++++
 cpukit/posix/src/keysetspecific.c             |    7 +++++++
 cpukit/posix/src/mqueuetimedreceive.c         |    7 +++++++
 cpukit/posix/src/mutexattrgetprotocol.c       |    7 +++++++
 cpukit/posix/src/nanosleep.c                  |    7 +++++++
 cpukit/posix/src/prwlockwrlock.c              |    7 +++++++
 cpukit/posix/src/psignalclearprocesssignals.c |    7 +++++++
 cpukit/posix/src/pthreadattrsetschedpolicy.c  |    7 +++++++
 cpukit/posix/src/pthreadgetcpuclockid.c       |    7 +++++++
 cpukit/posix/src/pthreadkill.c                |    7 +++++++
 cpukit/posix/src/rwlockattrsetpshared.c       |    7 +++++++
 cpukit/posix/src/sched_getprioritymax.c       |    7 +++++++
 cpukit/posix/src/sigdelset.c                  |    7 +++++++
 cpukit/posix/src/timerdelete.c                |    7 +++++++
 cpukit/posix/src/vfork.c                      |    7 +++++++
 20 files changed, 140 insertions(+), 0 deletions(-)

diff --git a/cpukit/posix/src/aio_read.c b/cpukit/posix/src/aio_read.c
index 63bbac9..f339752 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 at gmail.com> 
  * 
diff --git a/cpukit/posix/src/aio_suspend.c b/cpukit/posix/src/aio_suspend.c
index c42ee83..60c4af1 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 2c5a9da..46c1d46 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 9719147..592b823 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 9f4a394..6f686fe 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 83728bc..89b806c 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 5b7fb8b..e631127 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 ba79ce1..58f7961 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 584a380..1824b3f 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 d971126..02abe55 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 fffdbea..16e5ecd 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 3c3cdf4..3d1d16b 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 e095d71..ee7fe1f 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 51776f0..0b7e3bb 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 67ef0c7..420aaa5 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 f27a5b5..5a32530 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 a85f02b..5a77e25 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 a559e64..7567689 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 89cfe2f..473c0df 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 64838c8..3bb0f31 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).

More information about the vc mailing list