rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-10-18 14:27:14 +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

11
c-user/object-services/directives.rst
View File

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