diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-15 07:25:05 -0500 |
|---|---|---|
| committer | Gedare Bloom <gedare@rtems.org> | 2012-12-15 07:25:05 -0500 |
| commit | e43f4758af5414a28f82c8178f2b53d23031376a (patch) | |
| tree | 36d25b816ad087a9aa22748824ca4a3cc38e33d9 /cpukit/posix/src/pspinlock.c | |
| parent | libcsupport: Doxygen Enhancement Task #8 (diff) | |
| download | rtems-e43f4758af5414a28f82c8178f2b53d23031376a.tar.bz2 | |
posix: Doxygen Enhancement Task #1
http://www.google-melange.com/gci/task/view/google/gci2012/7987220
Diffstat (limited to 'cpukit/posix/src/pspinlock.c')
| -rw-r--r-- | cpukit/posix/src/pspinlock.c | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/cpukit/posix/src/pspinlock.c b/cpukit/posix/src/pspinlock.c index ce1a2bb3c5..7f6793c1d5 100644 --- a/cpukit/posix/src/pspinlock.c +++ b/cpukit/posix/src/pspinlock.c @@ -1,6 +1,11 @@ -/* - * POSIX Spinlock Manager -- Wait at a Spinlock +/** + * @file * + * @brief Wait at a Spinlock + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -19,19 +24,15 @@ #include <rtems/system.h> #include <rtems/posix/spinlock.h> -/* - * pthread_spin_lock - * +/** * This directive allows a thread to wait at a spinlock. * - * Input parameters: - * spinlock - spinlock id - * - * Output parameters: - * 0 - if successful - * error code - if unsuccessful + * @param[in] spinlock is spinlock id + * + * @return This method returns 0 if there was not an + * error. Otherwise, a status code is returned indicating the + * source of the error. */ - int pthread_spin_lock( pthread_spinlock_t *spinlock ) |