From 810ecf05af45f50b9650a7156a98f7058f656570 Mon Sep 17 00:00:00 2001 From: Mathew Kallada Date: Sun, 16 Dec 2012 08:38:02 -0500 Subject: 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 0d73022f95..727745ae67 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 daeb92771d..c416a7aa1b 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 59ed9e6703..37e3fd54b4 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 7e6cf23a8a..b606fd63df 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 10d44e0019..7a4c5142a6 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 c7b2cc55fc..3a34359297 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 fd9fed3f77..c6026e08d7 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 1c51ad5f03..fc7c1afe74 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 56f65b3b8f..4a9f1e964a 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 f1419034c3..44d1864118 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 ab0230f69a..75eaec73c1 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 6bb397ad11..95a3fa5423 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 390bcd1579..e71f2fa575 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 059a7fb728..3c42ee15e3 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 0852b29ec7..27d58ccec7 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 72211cdf9a..81eee4f9f9 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 ae564650e6..84f1fa560f 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 9827933c51..06854ca54b 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 e10d663815..a76d304a43 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 b2d61c53ce..1aa4713a85 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 33008366f5..9f54ad3add 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 545df3ec28..5591085af4 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). * -- cgit v1.2.3