rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-10-20 12:34:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

c-user: Generate API type documentation

Browse Source 
Close #4901.
This commit is contained in:
Sebastian Huber
2023-05-09 12:53:20 +02:00
parent 9c2498a728
commit e33eae15a7
19 changed files with 1735 additions and 326 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
c-user/message/directives.rst
View File

@@ -72,9 +72,9 @@ Creates a message queue.
This parameter is the attribute set of the message queue.
``id``
This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the created message queue
will be stored in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the created message
queue will be stored in this object.
.. rubric:: DESCRIPTION:
@@ -230,11 +230,12 @@ Constructs a message queue from the specified the message queue configuration.
.. rubric:: PARAMETERS:
``config``
This parameter is the message queue configuration.
This parameter is the pointer to an :ref:`InterfaceRtemsMessageQueueConfig`
object. It configures the message queue.
``id``
This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the constructed message
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the constructed message
queue will be stored in this object.
.. rubric:: RETURN VALUES:
@@ -361,9 +362,9 @@ Identifies a message queue by the object name.
This parameter is the node or node set to search for a matching object.
``id``
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 object.
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the object identifier of an object with
the specified name will be stored in this object.
.. rubric:: DESCRIPTION: