diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-06-14 09:18:23 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-06-15 07:47:38 +0200 |
| commit | c70715baea93828a0e7b27f4ae583dc254e1a6a9 (patch) | |
| tree | 5199462cc2405dcb6d1b070b2b9ff249ea6f43a8 /c-user/timer/directives.rst | |
| parent | user: add bsps/aarch64/a72.rst (diff) | |
| download | rtems-docs-c70715baea93828a0e7b27f4ae583dc254e1a6a9.tar.bz2 | |
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.
Diffstat (limited to 'c-user/timer/directives.rst')
| -rw-r--r-- | c-user/timer/directives.rst | 14 |
1 files changed, 7 insertions, 7 deletions
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: |