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/dual-ported-memory | |
| 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/dual-ported-memory')
| -rw-r--r-- | c-user/dual-ported-memory/directives.rst | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/c-user/dual-ported-memory/directives.rst b/c-user/dual-ported-memory/directives.rst index 42cb875..869fd4b 100644 --- a/c-user/dual-ported-memory/directives.rst +++ b/c-user/dual-ported-memory/directives.rst @@ -71,9 +71,9 @@ Creates a port. This parameter is the length in bytes of the memory area. ``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 port will be - stored in this variable. + stored in this object. .. rubric:: DESCRIPTION: @@ -158,9 +158,9 @@ Identifies a port 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: @@ -297,9 +297,9 @@ Converts the external address to the internal address. This parameter is the external address to convert. ``internal`` - This parameter is the pointer to a pointer variable. When the directive - call is successful, the external address associated with the internal - address will be stored in this variable. + This parameter is the pointer to a ``void`` pointer object. When the + directive call is successful, the external address associated with the + internal address will be stored in this object. .. rubric:: DESCRIPTION: @@ -367,9 +367,9 @@ Converts the internal address to the external address. This parameter is the internal address to convert. ``external`` - This parameter is the pointer to a pointer variable. When the directive - call is successful, the external address associated with the internal - address will be stored in this variable. + This parameter is the pointer to a ``void`` pointer object. When the + directive call is successful, the external address associated with the + internal address will be stored in this object. .. rubric:: DESCRIPTION: |