summaryrefslogtreecommitdiffstats
path: root/cpukit/posix/src/pbarrierwait.c
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2012-12-15 16:03:12 -0500
committerGedare Bloom <gedare@rtems.org>2012-12-15 16:03:12 -0500
commitd86308bdf8d231cd02bb72e4669f12c2689f4dac (patch)
treeb06e87f5718b4c3e0334fa8e17a219552ed9b923 /cpukit/posix/src/pbarrierwait.c
parentposix: Doxygen Enhancement Task #8 (diff)
downloadrtems-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/pbarrierwait.c')
-rw-r--r--cpukit/posix/src/pbarrierwait.c25
1 files changed, 13 insertions, 12 deletions
diff --git a/cpukit/posix/src/pbarrierwait.c b/cpukit/posix/src/pbarrierwait.c
index c5e73bcb26..0ad9634411 100644
--- a/cpukit/posix/src/pbarrierwait.c
+++ b/cpukit/posix/src/pbarrierwait.c
@@ -1,6 +1,11 @@
-/*
- * POSIX Barrier Manager -- Wait at a Barrier
+/**
+ * @file
*
+ * @brief Wait at a Barrier
+ * @ingroup POSIX
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -19,18 +24,14 @@
#include <rtems/system.h>
#include <rtems/posix/barrier.h>
-/*
- * pthread_barrier_wait
- *
- * This directive allows a thread to wait at a barrier.
+/**
+ * This directive allows a thread to wait at a barrier.
*
- * Input parameters:
- * barrier - barrier id
+ * @param[in] barrier is the barrier id
*
- * Output parameters:
- * 0 - if successful
- * PTHREAD_BARRIER_SERIAL_THREAD - if successful
- * error code - if unsuccessful
+ * @retval 0 if successful
+ * @retval PTHREAD_BARRIER_SERIAL_THREAD if successful
+ * @retval error_code if unsuccessful
*/
int pthread_barrier_wait(