[rtems commit] posix: Doxygen Enhancement Task #7

Gedare Bloom gedare at rtems.org
Sun Dec 16 13:33:52 UTC 2012


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

Author:    Mathew Kallada <matkallada at gmail.com>
Date:      Sun Dec 16 08:38:02 2012 -0500

posix: Doxygen Enhancement Task #7

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

---

 cpukit/posix/include/rtems/posix/mutex.h       |    6 +++---
 cpukit/posix/include/rtems/posix/psignalimpl.h |    3 +++
 cpukit/posix/include/semaphore.h               |   11 +++++++----
 cpukit/posix/src/_execve.c                     |    9 +++++++--
 cpukit/posix/src/execlp.c                      |    9 +++++++--
 cpukit/posix/src/keygetspecific.c              |    7 +++++++
 cpukit/posix/src/mutex.c                       |    7 +++++++
 cpukit/posix/src/mutexattrsetprotocol.c        |    7 +++++++
 cpukit/posix/src/mutexdestroy.c                |    7 +++++++
 cpukit/posix/src/mutexget.c                    |    9 +++++++--
 cpukit/posix/src/mutexunlock.c                 |    7 +++++++
 cpukit/posix/src/prwlocktimedrdlock.c          |    9 +++++++--
 cpukit/posix/src/psignalclearsignals.c         |    7 +++++++
 cpukit/posix/src/psxtransschedparam.c          |   10 +++++++++-
 cpukit/posix/src/pthreadattrdestroy.c          |    9 +++++++--
 cpukit/posix/src/pthreadattrgetguardsize.c     |    9 +++++++--
 cpukit/posix/src/pthreadattrgetinheritsched.c  |    9 +++++++--
 cpukit/posix/src/pthreadattrgetstacksize.c     |    9 +++++++--
 cpukit/posix/src/pthreadattrsetdetachstate.c   |    9 +++++++--
 cpukit/posix/src/sched_yield.c                 |    9 +++++++--
 cpukit/posix/src/semtimedwait.c                |    7 +++++++
 cpukit/posix/src/sigismember.c                 |    9 +++++++--
 22 files changed, 148 insertions(+), 30 deletions(-)

diff --git a/cpukit/posix/include/rtems/posix/mutex.h b/cpukit/posix/include/rtems/posix/mutex.h
index 0d73022..727745a 100644
--- a/cpukit/posix/include/rtems/posix/mutex.h
+++ b/cpukit/posix/include/rtems/posix/mutex.h
@@ -56,7 +56,7 @@ POSIX_EXTERN Objects_Information  _POSIX_Mutex_Information;
 POSIX_EXTERN pthread_mutexattr_t _POSIX_Mutex_Default_attributes;
 
 /*
- *  _POSIX_Mutex_Manager_initialization
+ *  @brief POSIX Mutex Manager Initialization
  *
  *  DESCRIPTION:
  *
@@ -144,9 +144,9 @@ int _POSIX_Mutex_Lock_support(
  *
  *  A support routine which converts core mutex status codes into the
  *  appropriate POSIX status values.
- * 
+ *
  *  @param[in] the_mutex_status is the mutex status code to translate
- * 
+ *
  *  @return the translated POSIX status code
  */
 
diff --git a/cpukit/posix/include/rtems/posix/psignalimpl.h b/cpukit/posix/include/rtems/posix/psignalimpl.h
index daeb927..c416a7a 100644
--- a/cpukit/posix/include/rtems/posix/psignalimpl.h
+++ b/cpukit/posix/include/rtems/posix/psignalimpl.h
@@ -101,6 +101,9 @@ bool _POSIX_signals_Check_signal(
   bool                is_global
 );
 
+/**
+ *  @brief POSIX Signals Clear Signals
+ */
 bool _POSIX_signals_Clear_signals(
   POSIX_API_Control  *api,
   int                 signo,
diff --git a/cpukit/posix/include/semaphore.h b/cpukit/posix/include/semaphore.h
index 59ed9e6..37e3fd5 100644
--- a/cpukit/posix/include/semaphore.h
+++ b/cpukit/posix/include/semaphore.h
@@ -56,7 +56,7 @@ int sem_init(
 
 /**
  *  @brief Destroy an Unnamed Semaphore
- * 
+ *
  *  11.2.2 Destroy an Unnamed Semaphore, P1003.1b-1993, p.220
  */
 int sem_destroy(
@@ -99,7 +99,7 @@ int sem_unlink(
 
 /**
  *  @brief Lock a Semaphore
- * 
+ *
  *  11.2.6 Lock a Semaphore, P1003.1b-1993, p.226
  *
  *  @note P1003.4b/D8 adds sem_timedwait(), p. 27
@@ -110,7 +110,7 @@ int sem_wait(
 
 /**
  *  @brief Lock a Semaphore
- * 
+ *
  *  @see sem_wait()
  */
 int sem_trywait(
@@ -118,6 +118,9 @@ int sem_trywait(
 );
 
 #if defined(_POSIX_TIMEOUTS)
+/**
+ *  @brief Lock a Semaphore
+ */
 int sem_timedwait(
   sem_t                 *sem,
   const struct timespec *timeout
@@ -126,7 +129,7 @@ int sem_timedwait(
 
 /**
  *  @brief Unlock a Semaphore
- * 
+ *
  *  11.2.7 Unlock a Semaphore, P1003.1b-1993, p.227
  */
 int sem_post(
diff --git a/cpukit/posix/src/_execve.c b/cpukit/posix/src/_execve.c
index 7e6cf23..b606fd6 100644
--- a/cpukit/posix/src/_execve.c
+++ b/cpukit/posix/src/_execve.c
@@ -1,6 +1,11 @@
-/*
- *  execve() - POSIX 1003.1b 3.1.2
+/**
+ * @file
  *
+ * @brief execve()
+ * @ingroup POSIX
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/posix/src/execlp.c b/cpukit/posix/src/execlp.c
index 10d44e0..7a4c514 100644
--- a/cpukit/posix/src/execlp.c
+++ b/cpukit/posix/src/execlp.c
@@ -1,6 +1,11 @@
-/*
- *  execlp() - POSIX 1003.1b 3.1.2
+/**
+ * @file
  *
+ * @brief execlp()
+ * @ingroup POSIX
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/posix/src/keygetspecific.c b/cpukit/posix/src/keygetspecific.c
index c7b2cc5..3a34359 100644
--- a/cpukit/posix/src/keygetspecific.c
+++ b/cpukit/posix/src/keygetspecific.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Thread-Specific Data Management
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/mutex.c b/cpukit/posix/src/mutex.c
index fd9fed3..c6026e0 100644
--- a/cpukit/posix/src/mutex.c
+++ b/cpukit/posix/src/mutex.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief POSIX Mutex Manager Initialization
+ * @ingroup POSIX_MUTEX POSIX Mutex Support
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/mutexattrsetprotocol.c b/cpukit/posix/src/mutexattrsetprotocol.c
index 1c51ad5..fc7c1af 100644
--- a/cpukit/posix/src/mutexattrsetprotocol.c
+++ b/cpukit/posix/src/mutexattrsetprotocol.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Mutex Initialization Scheduling Attributes
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/mutexdestroy.c b/cpukit/posix/src/mutexdestroy.c
index 56f65b3..4a9f1e9 100644
--- a/cpukit/posix/src/mutexdestroy.c
+++ b/cpukit/posix/src/mutexdestroy.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Initializing and Destroying a Mutex
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/mutexget.c b/cpukit/posix/src/mutexget.c
index f141903..44d1864 100644
--- a/cpukit/posix/src/mutexget.c
+++ b/cpukit/posix/src/mutexget.c
@@ -1,6 +1,11 @@
-/*
- *  Convert POSIX Mutex ID to local object pointer
+/**
+ * @file
  *
+ * @brief Convert POSIX Mutex ID to local object pointer
+ * @ingroup POSIX
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/posix/src/mutexunlock.c b/cpukit/posix/src/mutexunlock.c
index ab0230f..75eaec7 100644
--- a/cpukit/posix/src/mutexunlock.c
+++ b/cpukit/posix/src/mutexunlock.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Locking and Unlocking a Mutex
+ * @ingroup POSIX
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/prwlocktimedrdlock.c b/cpukit/posix/src/prwlocktimedrdlock.c
index 6bb397a..95a3fa5 100644
--- a/cpukit/posix/src/prwlocktimedrdlock.c
+++ b/cpukit/posix/src/prwlocktimedrdlock.c
@@ -1,6 +1,11 @@
-/*
- *  POSIX RWLock Manager -- Attempt to Obtain a Read Lock on a RWLock Instance
+/**
+ * @file
  *
+ * @brief Attempt to Obtain a Read Lock on a RWLock Instance
+ * @ingroup POSIX
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/posix/src/psignalclearsignals.c b/cpukit/posix/src/psignalclearsignals.c
index 390bcd1..e71f2fa 100644
--- a/cpukit/posix/src/psignalclearsignals.c
+++ b/cpukit/posix/src/psignalclearsignals.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief POSIX Signals Clear Signals
+ * @ingroup POSIX_SIGNALS POSIX Signals Support
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/psxtransschedparam.c b/cpukit/posix/src/psxtransschedparam.c
index 059a7fb..3c42ee1 100644
--- a/cpukit/posix/src/psxtransschedparam.c
+++ b/cpukit/posix/src/psxtransschedparam.c
@@ -1,4 +1,12 @@
-/*  COPYRIGHT (c) 1989-2009.
+/**
+ * @file
+ *
+ * @brief Translate sched_param into SuperCore Terms
+ * @ingroup POSIX_PTHREAD Private POSIX Threads
+ */
+
+/*
+ *  COPYRIGHT (c) 1989-2009.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
diff --git a/cpukit/posix/src/pthreadattrdestroy.c b/cpukit/posix/src/pthreadattrdestroy.c
index 0852b29..27d58cc 100644
--- a/cpukit/posix/src/pthreadattrdestroy.c
+++ b/cpukit/posix/src/pthreadattrdestroy.c
@@ -1,6 +1,11 @@
-/*
- *  16.1.1 Thread Creation Attributes, P1003.1c/Draft 10, p, 140
+/**
+ * @file
  *
+ * @brief Thread Creation Attributes
+ * @ingroup POSIX
+ */
+
+/*
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/posix/src/pthreadattrgetguardsize.c b/cpukit/posix/src/pthreadattrgetguardsize.c
index 72211cd..81eee4f 100644
--- a/cpukit/posix/src/pthreadattrgetguardsize.c
+++ b/cpukit/posix/src/pthreadattrgetguardsize.c
@@ -1,6 +1,11 @@
-/*
- *  16.1.1 Thread Creation Attributes
+/**
+ * @file
  *
+ * @brief Thread Creation Attributes
+ * @ingroup POSIX
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2010.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/posix/src/pthreadattrgetinheritsched.c b/cpukit/posix/src/pthreadattrgetinheritsched.c
index ae56465..84f1fa5 100644
--- a/cpukit/posix/src/pthreadattrgetinheritsched.c
+++ b/cpukit/posix/src/pthreadattrgetinheritsched.c
@@ -1,6 +1,11 @@
-/*
- *  13.5.1 Thread Creation Scheduling Attributes, P1003.1c/Draft 10, p. 120
+/**
+ * @file
  *
+ * @brief Thread Creation Scheduling Attributes
+ * @ingroup POSIX
+ */
+
+/*
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/posix/src/pthreadattrgetstacksize.c b/cpukit/posix/src/pthreadattrgetstacksize.c
index 9827933..06854ca 100644
--- a/cpukit/posix/src/pthreadattrgetstacksize.c
+++ b/cpukit/posix/src/pthreadattrgetstacksize.c
@@ -1,6 +1,11 @@
-/*
- *  16.1.1 Thread Creation Attributes, P1003.1c/Draft 10, p, 140
+/**
+ * @file
  *
+ * @brief Thread Creation Attributes
+ * @ingroup POSIX
+ */
+
+/*
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/posix/src/pthreadattrsetdetachstate.c b/cpukit/posix/src/pthreadattrsetdetachstate.c
index e10d663..a76d304 100644
--- a/cpukit/posix/src/pthreadattrsetdetachstate.c
+++ b/cpukit/posix/src/pthreadattrsetdetachstate.c
@@ -1,6 +1,11 @@
-/*
- *  16.1.1 Thread Creation Attributes, P1003.1c/Draft 10, p, 140
+/**
+ * @file
  *
+ * @brief Thread Creation Attributes
+ * @ingroup POSIX
+ */
+
+/*
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/posix/src/sched_yield.c b/cpukit/posix/src/sched_yield.c
index b2d61c5..1aa4713 100644
--- a/cpukit/posix/src/sched_yield.c
+++ b/cpukit/posix/src/sched_yield.c
@@ -1,6 +1,11 @@
-/*
- *  13.3.5 Yield Processor, P1003.1b-1993, p. 257
+/**
+ * @file
  *
+ * @brief Yield Processor
+ * @ingroup POSIX
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/posix/src/semtimedwait.c b/cpukit/posix/src/semtimedwait.c
index 3300836..9f54ad3 100644
--- a/cpukit/posix/src/semtimedwait.c
+++ b/cpukit/posix/src/semtimedwait.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Lock a Semaphore
+ * @ingroup POSIX_SEMAPHORE POSIX Semaphores Support
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/posix/src/sigismember.c b/cpukit/posix/src/sigismember.c
index 545df3e..5591085 100644
--- a/cpukit/posix/src/sigismember.c
+++ b/cpukit/posix/src/sigismember.c
@@ -1,6 +1,11 @@
-/*
- *  3.3.3 Manipulate Signal Sets, P1003.1b-1993, p. 69
+/**
+ * @file
  *
+ * @brief Manipulate Signal Sets
+ * @ingroup POSIX
+ */
+
+/*
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *




More information about the vc mailing list