rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-10-20 17:54:31 +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

14
c-user/timer/directives.rst
View File

@@ -55,9 +55,9 @@ Creates a timer.
This parameter is the object name of the timer.
``id``
This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the created timer 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 timer will
be stored in this object.
.. rubric:: DESCRIPTION:
@@ -137,9 +137,9 @@ Identifies a timer by the object name.
This parameter is the object name to look up.
``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:
@@ -811,7 +811,7 @@ Gets information about the timer.
This parameter is the timer identifier.
``the_info``
This parameter is the pointer to an :c:type:`rtems_timer_information`
This parameter is the pointer to an :ref:`InterfaceRtemsTimerInformation`
object. When the directive call is successful, the information about the
timer will be stored in this object.