diff options
| author | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-12-20 04:10:01 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-12-20 04:10:01 -0600 |
| commit | 4e663ae7b5f896be300acf5c31d18d582ae44604 (patch) | |
| tree | 4e7c41687150824dab00588c2f0c7ae4b8c5b1e4 /cpukit/posix/src/prwlockrdlock.c | |
| parent | Merge branch 'master' of ssh://git.rtems.org/data/git/rtems (diff) | |
| parent | libfs: Doxygen Enhancement Task #1 (diff) | |
| download | rtems-4e663ae7b5f896be300acf5c31d18d582ae44604.tar.bz2 | |
Merge branch 'master' of ssh://git.rtems.org/data/git/rtems
Diffstat (limited to 'cpukit/posix/src/prwlockrdlock.c')
| -rw-r--r-- | cpukit/posix/src/prwlockrdlock.c | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/cpukit/posix/src/prwlockrdlock.c b/cpukit/posix/src/prwlockrdlock.c index ec75fea823..0ce4764915 100644 --- a/cpukit/posix/src/prwlockrdlock.c +++ b/cpukit/posix/src/prwlockrdlock.c @@ -1,6 +1,11 @@ -/* - * POSIX RWLock Manager -- Obtain a Read Lock on a RWLock Instance +/** + * @file * + * @brief Obtain a Read Lock on a RWLock Instance + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -19,17 +24,13 @@ #include <rtems/system.h> #include <rtems/posix/rwlock.h> -/* - * pthread_rwlock_rdlock - * - * This directive attempts to obtain a read only lock on an rwlock instance. +/** + * This directive attempts to obtain a read only lock on an rwlock instance. * - * Input parameters: - * rwlock - pointer to rwlock id + * @param[in] rwlock is the pointer to rwlock id * - * Output parameters: - * 0 - if successful - * error code - if unsuccessful + * @retval 0 if successful + * @retval error_code if unsuccessful */ int pthread_rwlock_rdlock( |