From c70715baea93828a0e7b27f4ae583dc254e1a6a9 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Mon, 14 Jun 2021 09:18:23 +0200 Subject: c-user: Use a common phrase for pointer parameters Mention the type of the pointer in the parameter description. Use the more general term "object" instead of "variable". Update #3993. --- c-user/barrier/directives.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) (limited to 'c-user/barrier') diff --git a/c-user/barrier/directives.rst b/c-user/barrier/directives.rst index ec40844..59abc51 100644 --- a/c-user/barrier/directives.rst +++ b/c-user/barrier/directives.rst @@ -67,9 +67,9 @@ Creates a barrier. barrier. ``id`` - This parameter is the pointer to an object identifier variable. When the + This parameter is the pointer to an :c:type:`rtems_id` object. When the directive call is successful, the identifier of the created barrier will be - stored in this variable. + stored in this object. .. rubric:: DESCRIPTION: @@ -175,9 +175,9 @@ Identifies a barrier by the object name. This parameter is the object name to look up. ``id`` - This parameter is the pointer to an object identifier variable. When the + This parameter is the pointer to an :c:type:`rtems_id` object. When the directive call is successful, the object identifier of an object with the - specified name will be stored in this variable. + specified name will be stored in this object. .. rubric:: DESCRIPTION: @@ -380,9 +380,10 @@ Releases the barrier. This parameter is the barrier identifier. ``released`` - This parameter is the pointer to an integer variable. When the directive - call is successful, the number of released tasks will be stored in this - variable. + This parameter is the pointer to an `uint32_t + `_ object. When the + directive call is successful, the number of released tasks will be stored + in this object. .. rubric:: DESCRIPTION: -- cgit v1.2.3