diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-15 09:54:10 -0500 |
|---|---|---|
| committer | Gedare Bloom <gedare@rtems.org> | 2012-12-15 09:54:10 -0500 |
| commit | e49a36cb0b37cc3ad1c3f191fb439b17f6365539 (patch) | |
| tree | 1c39de36e4c7a90413f55288ed86d076cef1afbf /cpukit/posix/src/pbarrierdestroy.c | |
| parent | libcsupport: Update file header for termios.h to remove link, add description. (diff) | |
| download | rtems-e49a36cb0b37cc3ad1c3f191fb439b17f6365539.tar.bz2 | |
posix: Doxygen Enhancement Task #5
http://www.google-melange.com/gci/task/view/google/gci2012/7959229
Diffstat (limited to 'cpukit/posix/src/pbarrierdestroy.c')
| -rw-r--r-- | cpukit/posix/src/pbarrierdestroy.c | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/cpukit/posix/src/pbarrierdestroy.c b/cpukit/posix/src/pbarrierdestroy.c index a8f6ce3b5e..6b2e9d0bc9 100644 --- a/cpukit/posix/src/pbarrierdestroy.c +++ b/cpukit/posix/src/pbarrierdestroy.c @@ -1,6 +1,11 @@ -/* - * POSIX Barrier Manager -- Destroy a Barrier +/** + * @file * + * @brief Destroy a Barrier Object + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -19,21 +24,17 @@ #include <rtems/system.h> #include <rtems/posix/barrier.h> -/* - * pthread_barrier_destroy - * +/** * This directive allows a thread to delete a barrier specified by * the barrier id. The barrier is freed back to the inactive * barrier chain. * - * Input parameters: - * barrier - barrier id - * - * Output parameters: - * 0 - if successful - * error code - if unsuccessful + * @param[in] barrier is the barrier 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_barrier_destroy( pthread_barrier_t *barrier ) |