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

26
c-user/scheduling-concepts/directives.rst
View File

@@ -54,8 +54,8 @@ Identifies a scheduler by the object name.
This parameter is the scheduler name to look up.
``id``
This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the scheduler will be
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the scheduler will be
stored in this object.
.. rubric:: DESCRIPTION:
@@ -120,8 +120,8 @@ Identifies a scheduler by the processor index.
This parameter is the processor index to identify the scheduler.
``id``
This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the scheduler will be
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the scheduler will be
stored in this object.
.. rubric:: RETURN VALUES:
@@ -184,8 +184,8 @@ Identifies a scheduler by the processor set.
processor set will be used to identify the scheduler.
``id``
This parameter is the pointer to an :c:type:`rtems_id` object. When the
directive call is successful, the identifier of the scheduler will be
This parameter is the pointer to an :ref:`InterfaceRtemsId` object. When
the directive call is successful, the identifier of the scheduler will be
stored in this object.
.. rubric:: DESCRIPTION:
@@ -254,9 +254,9 @@ Gets the maximum task priority of the scheduler.
This parameter is the scheduler identifier.
``priority``
This parameter is the pointer to an :c:type:`rtems_task_priority` object.
When the directive the maximum priority of the scheduler will be stored in
this object.
This parameter is the pointer to an :ref:`InterfaceRtemsTaskPriority`
object. When the directive the maximum priority of the scheduler will be
stored in this object.
.. rubric:: RETURN VALUES:
@@ -375,10 +375,10 @@ Maps a POSIX thread priority to the corresponding Classic API task priority.
This parameter is the POSIX thread priority to map.
``priority``
This parameter is the pointer to an :c:type:`rtems_task_priority` object.
When the directive call is successful, the Classic API task priority value
corresponding to the specified POSIX thread priority value will be stored
in this object.
This parameter is the pointer to an :ref:`InterfaceRtemsTaskPriority`
object. When the directive call is successful, the Classic API task
priority value corresponding to the specified POSIX thread priority value
will be stored in this object.
.. rubric:: RETURN VALUES: