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/timer/directives.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'c-user/timer/directives.rst') diff --git a/c-user/timer/directives.rst b/c-user/timer/directives.rst index 2affe42..f020de4 100644 --- a/c-user/timer/directives.rst +++ b/c-user/timer/directives.rst @@ -55,9 +55,9 @@ Creates a timer. This parameter is the object name of the timer. ``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 timer will be - stored in this variable. + stored in this object. .. rubric:: DESCRIPTION: @@ -137,9 +137,9 @@ Identifies a timer 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: @@ -811,9 +811,9 @@ Gets information about the timer. This parameter is the timer identifier. ``the_info`` - This parameter is the pointer to a timer information variable. When the - directive call is successful, the information about the timer will be - stored in this variable. + This parameter is the pointer to an :c:type:`rtems_timer_information` + object. When the directive call is successful, the information about the + timer will be stored in this object. .. rubric:: DESCRIPTION: -- cgit v1.2.3