diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-05-09 12:53:20 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-05-09 14:06:01 +0200 |
| commit | e33eae15a79e9b58c381554a674905f371d9e1ec (patch) | |
| tree | 12d9571b6e023020f7cfb600bbab25fad277249e /c-user/message/directives.rst | |
| parent | eng: Add unspecified header file item type (diff) | |
| download | rtems-docs-e33eae15a79e9b58c381554a674905f371d9e1ec.tar.bz2 | |
c-user: Generate API type documentation
Close #4901.
Diffstat (limited to 'c-user/message/directives.rst')
| -rw-r--r-- | c-user/message/directives.rst | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/c-user/message/directives.rst b/c-user/message/directives.rst index a13e4c7..d6e6eea 100644 --- a/c-user/message/directives.rst +++ b/c-user/message/directives.rst @@ -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: |