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/object-services/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/object-services/directives.rst')
| -rw-r--r-- | c-user/object-services/directives.rst | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/c-user/object-services/directives.rst b/c-user/object-services/directives.rst index 54f234f..c975c75 100644 --- a/c-user/object-services/directives.rst +++ b/c-user/object-services/directives.rst @@ -168,9 +168,9 @@ Gets the object name associated with the object identifier. This parameter is the object identifier to get the name. ``name`` - This parameter is the pointer to an object name variable. When the + This parameter is the pointer to an :c:type:`rtems_name` object. When the directive call is successful, the object name associated with the object - identifier will be stored in this variable. + identifier will be stored in this object. .. rubric:: RETURN VALUES: @@ -801,9 +801,10 @@ Gets the object class information of the object class of the object API. information. ``info`` - This parameter is the pointer to an object class information variable. - When the directive call is successful, the object class information of the - class of the API will be stored in this variable. + This parameter is the pointer to an + :c:type:`rtems_object_api_class_information` object. When the directive + call is successful, the object class information of the class of the API + will be stored in this object. .. rubric:: RETURN VALUES: |