diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-15 16:03:12 -0500 |
|---|---|---|
| committer | Gedare Bloom <gedare@rtems.org> | 2012-12-15 16:03:12 -0500 |
| commit | d86308bdf8d231cd02bb72e4669f12c2689f4dac (patch) | |
| tree | b06e87f5718b4c3e0334fa8e17a219552ed9b923 /cpukit/posix/src/prwlockrdlock.c | |
| parent | posix: Doxygen Enhancement Task #8 (diff) | |
| download | rtems-d86308bdf8d231cd02bb72e4669f12c2689f4dac.tar.bz2 | |
posix: Doxygen Enhancement Task #2
http://www.google-melange.com/gci/task/view/google/gci2012/7988213
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( |