rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-10-19 04:41:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

c-user: Use a common phrase for pointer parameters

Browse Source 
Mention the type of the pointer in the parameter description.  Use the
more general term "object" instead of "variable".

Update #3993.
This commit is contained in:
Sebastian Huber
2021-06-14 09:18:23 +02:00
parent 1a281869a9
commit c70715baea
15 changed files with 163 additions and 159 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
c-user/timer/directives.rst
View File

@@ -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: