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/scheduling-concepts/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/scheduling-concepts/directives.rst')
| -rw-r--r-- | c-user/scheduling-concepts/directives.rst | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/c-user/scheduling-concepts/directives.rst b/c-user/scheduling-concepts/directives.rst index 1827060..7d365ad 100644 --- a/c-user/scheduling-concepts/directives.rst +++ b/c-user/scheduling-concepts/directives.rst @@ -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: |