diff mbox

odp_barrier.h: Add doxygen in/out

Message ID 1415379258-40151-1-git-send-email-mike.holmes@linaro.org
State Rejected
Headers show

Commit Message

Mike Holmes Nov. 7, 2014, 4:54 p.m. UTC
Also fixed spelling

Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
---
 platform/linux-generic/include/api/odp_barrier.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Comments

Bill Fischofer Nov. 7, 2014, 5:43 p.m. UTC | #1
On Fri, Nov 7, 2014 at 10:54 AM, Mike Holmes <mike.holmes@linaro.org> wrote:

> Also fixed spelling
>
> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
>

Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>

> ---
>  platform/linux-generic/include/api/odp_barrier.h | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/platform/linux-generic/include/api/odp_barrier.h
> b/platform/linux-generic/include/api/odp_barrier.h
> index fb02a9d..08338c3 100644
> --- a/platform/linux-generic/include/api/odp_barrier.h
> +++ b/platform/linux-generic/include/api/odp_barrier.h
> @@ -39,16 +39,16 @@ typedef struct odp_barrier_t {
>  /**
>   * Init barrier with thread count
>   *
> - * @param barrier    Barrier
> - * @param count      Thread count
> + * @param[out] barrier Barrier
> + * @param[in]  count Thread count
>   */
>  void odp_barrier_init_count(odp_barrier_t *barrier, int count);
>
>
>  /**
> - * Synchronise thread execution on barrier
> + * Synchronize thread execution on barrier
>   *
> - * @param barrier    Barrier
> + * @param[in,out] barrier Barrier
>   */
>  void odp_barrier_sync(odp_barrier_t *barrier);
>
> --
> 2.1.0
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
>
diff mbox

Patch

diff --git a/platform/linux-generic/include/api/odp_barrier.h b/platform/linux-generic/include/api/odp_barrier.h
index fb02a9d..08338c3 100644
--- a/platform/linux-generic/include/api/odp_barrier.h
+++ b/platform/linux-generic/include/api/odp_barrier.h
@@ -39,16 +39,16 @@  typedef struct odp_barrier_t {
 /**
  * Init barrier with thread count
  *
- * @param barrier    Barrier
- * @param count      Thread count
+ * @param[out] barrier Barrier
+ * @param[in]  count Thread count
  */
 void odp_barrier_init_count(odp_barrier_t *barrier, int count);
 
 
 /**
- * Synchronise thread execution on barrier
+ * Synchronize thread execution on barrier
  *
- * @param barrier    Barrier
+ * @param[in,out] barrier Barrier
  */
 void odp_barrier_sync(odp_barrier_t *barrier);