api:odp_barrier.h: Update doxygen comments, renaming of function params

Signed-off-by: Ola Liljedahl <ola.liljedahl@linaro.org>
Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>
Reviewed-by: Mike Holmes <mike.holmes@linaro.org>
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>

1 files changed, 13 insertions, 9 deletions

diff --git a/platform/linux-generic/include/api/odp_barrier.h b/platform/linux-generic/include/api/odp_barrier.h
index 1790ea3a7..423982f3c 100644
--- a/platform/linux-generic/include/api/odp_barrier.h
+++ b/platform/linux-generic/include/api/odp_barrier.h
@@ -23,12 +23,12 @@ extern "C" {
 #include <odp_atomic.h>
 
 /** @addtogroup odp_synchronizers
- *  Barrier between threads.
+ *  Synchronize threads.
  *  @{
  */
 
 /**
- * ODP execution barrier
+ * ODP thread synchronization barrier
  */
 typedef struct odp_barrier_t {
 	uint32_t         count;  /**< @private Thread count */
@@ -37,20 +37,24 @@ typedef struct odp_barrier_t {
 
 
 /**
- * Init barrier with thread count
+ * Initialize barrier with thread count.
  *
- * @param barrier    Barrier
- * @param count      Thread count
+ * @param barr Pointer to a barrier variable
+ * @param count Thread count
  */
-void odp_barrier_init(odp_barrier_t *barrier, int count);
+void odp_barrier_init(odp_barrier_t *barr, int count);
 
 
 /**
- * Synchronise thread execution on barrier
+ * Synchronize thread execution on barrier.
+ * Wait for all threads to arrive at the barrier until they are let loose again.
+ * Threads will block (spin) until the last thread has arrived at the barrier.
+ * All memory operations before the odp_barrier_wait() call will be visible
+ * to all threads when they leave the barrier.
  *
- * @param barrier    Barrier
+ * @param barr Pointer to a barrier variable
  */
-void odp_barrier_wait(odp_barrier_t *barrier);
+void odp_barrier_wait(odp_barrier_t *barr);
 
 /**
  * @}