c-user/*: Add trailing parentheses on methods in index which were missing it

Closes #4766.
This commit is contained in:
Joel Sherrill
2022-11-30 09:59:20 -06:00
parent 82b3a44cfd
commit aaba6e5826
11 changed files with 71 additions and 71 deletions

View File

@@ -220,7 +220,7 @@ The section details the Chains directives.
.. _rtems_chain_initialize: .. _rtems_chain_initialize:
.. index:: chain initialize .. index:: chain initialize
.. index:: rtems_chain_initialize .. index:: rtems_chain_initialize()
Initialize Chain With Nodes Initialize Chain With Nodes
--------------------------- ---------------------------
@@ -258,7 +258,7 @@ NOTES:
.. _rtems_chain_initialize_empty: .. _rtems_chain_initialize_empty:
.. index:: chain initialize empty .. index:: chain initialize empty
.. index:: rtems_chain_initialize_empty .. index:: rtems_chain_initialize_empty()
Initialize Empty Initialize Empty
---------------- ----------------
@@ -287,7 +287,7 @@ NOTES:
.. _rtems_chain_is_null_node: .. _rtems_chain_is_null_node:
.. index:: chain is node null .. index:: chain is node null
.. index:: rtems_chain_is_null_node .. index:: rtems_chain_is_null_node()
Is Null Node ? Is Null Node ?
-------------- --------------
@@ -313,7 +313,7 @@ DESCRIPTION:
.. _rtems_chain_head: .. _rtems_chain_head:
.. index:: chain get head .. index:: chain get head
.. index:: rtems_chain_head .. index:: rtems_chain_head()
Head Head
---- ----
@@ -338,7 +338,7 @@ DESCRIPTION:
.. _rtems_chain_tail: .. _rtems_chain_tail:
.. index:: chain get tail .. index:: chain get tail
.. index:: rtems_chain_tail .. index:: rtems_chain_tail()
Tail Tail
---- ----
@@ -363,7 +363,7 @@ DESCRIPTION:
.. _rtems_chain_are_nodes_equal: .. _rtems_chain_are_nodes_equal:
.. index:: chare are nodes equal .. index:: chare are nodes equal
.. index:: rtems_chain_are_nodes_equal .. index:: rtems_chain_are_nodes_equal()
Are Two Nodes Equal ? Are Two Nodes Equal ?
--------------------- ---------------------
@@ -391,7 +391,7 @@ DESCRIPTION:
.. _rtems_chain_is_empty: .. _rtems_chain_is_empty:
.. index:: chain is chain empty .. index:: chain is chain empty
.. index:: rtems_chain_is_empty .. index:: rtems_chain_is_empty()
Is the Chain Empty Is the Chain Empty
------------------ ------------------
@@ -418,7 +418,7 @@ DESCRIPTION:
.. _rtems_chain_is_first: .. _rtems_chain_is_first:
.. index:: chain is node the first .. index:: chain is node the first
.. index:: rtems_chain_is_first .. index:: rtems_chain_is_first()
Is this the First Node on the Chain ? Is this the First Node on the Chain ?
------------------------------------- -------------------------------------
@@ -445,7 +445,7 @@ DESCRIPTION:
.. _rtems_chain_is_last: .. _rtems_chain_is_last:
.. index:: chain is node the last .. index:: chain is node the last
.. index:: rtems_chain_is_last .. index:: rtems_chain_is_last()
Is this the Last Node on the Chain ? Is this the Last Node on the Chain ?
------------------------------------ ------------------------------------
@@ -472,7 +472,7 @@ DESCRIPTION:
.. _rtems_chain_has_only_one_node: .. _rtems_chain_has_only_one_node:
.. index:: chain only one node .. index:: chain only one node
.. index:: rtems_chain_has_only_one_node .. index:: rtems_chain_has_only_one_node()
Does this Chain have only One Node ? Does this Chain have only One Node ?
------------------------------------ ------------------------------------
@@ -499,7 +499,7 @@ DESCRIPTION:
.. _rtems_chain_node_count_unprotected: .. _rtems_chain_node_count_unprotected:
.. index:: chain only one node .. index:: chain only one node
.. index:: rtems_chain_node_count_unprotected .. index:: rtems_chain_node_count_unprotected()
Returns the node count of the chain (unprotected) Returns the node count of the chain (unprotected)
------------------------------------------------- -------------------------------------------------
@@ -524,7 +524,7 @@ DESCRIPTION:
.. _rtems_chain_is_head: .. _rtems_chain_is_head:
.. index:: chain is node the head .. index:: chain is node the head
.. index:: rtems_chain_is_head .. index:: rtems_chain_is_head()
Is this Node the Chain Head ? Is this Node the Chain Head ?
----------------------------- -----------------------------
@@ -552,7 +552,7 @@ DESCRIPTION:
.. _rtems_chain_is_tail: .. _rtems_chain_is_tail:
.. index:: chain is node the tail .. index:: chain is node the tail
.. index:: rtems_chain_is_tail .. index:: rtems_chain_is_tail()
Is this Node the Chain Tail ? Is this Node the Chain Tail ?
----------------------------- -----------------------------
@@ -580,7 +580,7 @@ DESCRIPTION:
.. _rtems_chain_extract: .. _rtems_chain_extract:
.. index:: chain extract a node .. index:: chain extract a node
.. index:: rtems_chain_extract .. index:: rtems_chain_extract()
Extract a Node Extract a Node
-------------- --------------
@@ -611,7 +611,7 @@ NOTES:
.. _rtems_chain_extract_unprotected: .. _rtems_chain_extract_unprotected:
.. index:: chain extract a node unprotected .. index:: chain extract a node unprotected
.. index:: rtems_chain_extract_unprotected .. index:: rtems_chain_extract_unprotected()
Extract a Node (unprotected) Extract a Node (unprotected)
---------------------------- ----------------------------
@@ -639,7 +639,7 @@ NOTES:
.. _rtems_chain_get: .. _rtems_chain_get:
.. index:: chain get first node .. index:: chain get first node
.. index:: rtems_chain_get .. index:: rtems_chain_get()
Get the First Node Get the First Node
------------------ ------------------
@@ -672,7 +672,7 @@ NOTES:
.. _rtems_chain_get_unprotected: .. _rtems_chain_get_unprotected:
.. index:: chain get first node .. index:: chain get first node
.. index:: rtems_chain_get_unprotected .. index:: rtems_chain_get_unprotected()
Get the First Node (unprotected) Get the First Node (unprotected)
-------------------------------- --------------------------------
@@ -701,7 +701,7 @@ NOTES:
.. _rtems_chain_insert: .. _rtems_chain_insert:
.. index:: chain insert a node .. index:: chain insert a node
.. index:: rtems_chain_insert .. index:: rtems_chain_insert()
Insert a Node Insert a Node
------------- -------------
@@ -734,7 +734,7 @@ NOTES:
.. _rtems_chain_insert_unprotected: .. _rtems_chain_insert_unprotected:
.. index:: chain insert a node unprotected .. index:: chain insert a node unprotected
.. index:: rtems_chain_insert_unprotected .. index:: rtems_chain_insert_unprotected()
Insert a Node (unprotected) Insert a Node (unprotected)
--------------------------- ---------------------------
@@ -764,7 +764,7 @@ NOTES:
.. _rtems_chain_append: .. _rtems_chain_append:
.. index:: chain append a node .. index:: chain append a node
.. index:: rtems_chain_append .. index:: rtems_chain_append()
Append a Node Append a Node
------------- -------------
@@ -796,7 +796,7 @@ NOTES:
.. _rtems_chain_append_unprotected: .. _rtems_chain_append_unprotected:
.. index:: chain append a node unprotected .. index:: chain append a node unprotected
.. index:: rtems_chain_append_unprotected .. index:: rtems_chain_append_unprotected()
Append a Node (unprotected) Append a Node (unprotected)
--------------------------- ---------------------------
@@ -825,7 +825,7 @@ NOTES:
.. _rtems_chain_prepend: .. _rtems_chain_prepend:
.. index:: prepend node .. index:: prepend node
.. index:: rtems_chain_prepend .. index:: rtems_chain_prepend()
Prepend a Node Prepend a Node
-------------- --------------
@@ -857,7 +857,7 @@ NOTES:
.. _rtems_chain_prepend_unprotected: .. _rtems_chain_prepend_unprotected:
.. index:: prepend node unprotected .. index:: prepend node unprotected
.. index:: rtems_chain_prepend_unprotected .. index:: rtems_chain_prepend_unprotected()
Prepend a Node (unprotected) Prepend a Node (unprotected)
---------------------------- ----------------------------

View File

@@ -14,7 +14,7 @@ Removed Directives
CLOCK_GET - Get date and time information CLOCK_GET - Get date and time information
----------------------------------------- -----------------------------------------
.. index:: obtain the time of day .. index:: obtain the time of day
.. index:: rtems_clock_get .. index:: rtems_clock_get()
.. warning:: .. warning::

View File

@@ -233,7 +233,7 @@ sequence, related constants, usage, and status codes.
\clearpage \clearpage
.. index:: initialize the CBS library .. index:: initialize the CBS library
.. index:: rtems_cbs_initialize .. index:: rtems_cbs_initialize()
.. _rtems_cbs_initialize: .. _rtems_cbs_initialize:
CBS_INITIALIZE - Initialize the CBS library CBS_INITIALIZE - Initialize the CBS library
@@ -271,7 +271,7 @@ NOTES:
\clearpage \clearpage
.. index:: cleanup the CBS library .. index:: cleanup the CBS library
.. index:: rtems_cbs_cleanup .. index:: rtems_cbs_cleanup()
.. _rtems_cbs_cleanup: .. _rtems_cbs_cleanup:
@@ -302,7 +302,7 @@ NOTES:
\clearpage \clearpage
.. index:: create a new bandwidth server .. index:: create a new bandwidth server
.. index:: rtems_cbs_create_server .. index:: rtems_cbs_create_server()
.. _rtems_cbs_create_server: .. _rtems_cbs_create_server:
@@ -351,7 +351,7 @@ NOTES:
\clearpage \clearpage
.. index:: attach a thread to server .. index:: attach a thread to server
.. index:: rtems_cbs_attach_thread .. index:: rtems_cbs_attach_thread()
.. _rtems_cbs_attach_thread: .. _rtems_cbs_attach_thread:
@@ -394,7 +394,7 @@ NOTES:
\clearpage \clearpage
.. index:: detach a thread from server .. index:: detach a thread from server
.. index:: rtems_cbs_detach_thread .. index:: rtems_cbs_detach_thread()
.. _rtems_cbs_detach_thread: .. _rtems_cbs_detach_thread:
@@ -432,7 +432,7 @@ NOTES:
\clearpage \clearpage
.. index:: destroy a bandwidth server .. index:: destroy a bandwidth server
.. index:: rtems_cbs_destroy_server .. index:: rtems_cbs_destroy_server()
.. _rtems_cbs_destroy_server: .. _rtems_cbs_destroy_server:
@@ -470,7 +470,7 @@ NOTES:
\clearpage \clearpage
.. index:: get an ID of a server .. index:: get an ID of a server
.. index:: rtems_cbs_get_server_id .. index:: rtems_cbs_get_server_id()
.. _rtems_cbs_get_server_id: .. _rtems_cbs_get_server_id:
@@ -502,7 +502,7 @@ DESCRIPTION:
\clearpage \clearpage
.. index:: get scheduling parameters of a server .. index:: get scheduling parameters of a server
.. index:: rtems_cbs_get_parameters .. index:: rtems_cbs_get_parameters()
.. _rtems_cbs_get_parameters: .. _rtems_cbs_get_parameters:
@@ -540,7 +540,7 @@ NOTES:
\clearpage \clearpage
.. index:: set scheduling parameters .. index:: set scheduling parameters
.. index:: rtems_cbs_set_parameters .. index:: rtems_cbs_set_parameters()
.. _rtems_cbs_set_parameters: .. _rtems_cbs_set_parameters:
@@ -580,7 +580,7 @@ NOTES:
\clearpage \clearpage
.. index:: get elapsed execution time .. index:: get elapsed execution time
.. index:: rtems_cbs_get_execution_time .. index:: rtems_cbs_get_execution_time()
.. _rtems_cbs_get_execution_time: .. _rtems_cbs_get_execution_time:
@@ -619,7 +619,7 @@ NOTES:
\clearpage \clearpage
.. index:: get remaining execution time .. index:: get remaining execution time
.. index:: rtems_cbs_get_remaining_budget .. index:: rtems_cbs_get_remaining_budget()
.. _rtems_cbs_get_remaining_budget: .. _rtems_cbs_get_remaining_budget:
@@ -658,7 +658,7 @@ NOTES:
\clearpage \clearpage
.. index:: get scheduler approved execution time .. index:: get scheduler approved execution time
.. index:: rtems_cbs_get_approved_budget .. index:: rtems_cbs_get_approved_budget()
.. _rtems_cbs_get_approved_budget: .. _rtems_cbs_get_approved_budget:

View File

@@ -108,7 +108,7 @@ calling sequence, related constants, usage, and status codes.
\clearpage \clearpage
.. index:: rtems_cpu_usage_report .. index:: rtems_cpu_usage_report()
.. _rtems_cpu_usage_report: .. _rtems_cpu_usage_report:
@@ -134,7 +134,7 @@ NOTES:
\clearpage \clearpage
.. index:: rtems_cpu_usage_reset .. index:: rtems_cpu_usage_reset()
.. _rtems_cpu_usage_reset: .. _rtems_cpu_usage_reset:

View File

@@ -87,7 +87,7 @@ The directives are:
\clearpage \clearpage
.. index:: rtems_status_text .. index:: rtems_status_text()
.. _rtems_status_text: .. _rtems_status_text:

View File

@@ -45,7 +45,7 @@ An object name is an unsigned thirty-two bit entity associated with the object
by the user. The data type ``rtems_name`` is used to store object by the user. The data type ``rtems_name`` is used to store object
names. names.
.. index:: rtems_build_name .. index:: rtems_build_name()
Although not required by RTEMS, object names are often composed of four ASCII Although not required by RTEMS, object names are often composed of four ASCII
characters which help identify that object. For example, a task which causes a characters which help identify that object. For example, a task which causes a
@@ -64,7 +64,7 @@ would be difficult to assign meaningful ASCII names to each task. A more
convenient approach would be to name them the binary values one through convenient approach would be to name them the binary values one through
one-hundred, respectively. one-hundred, respectively.
.. index:: rtems_object_get_name .. index:: rtems_object_get_name()
RTEMS provides a helper routine, ``rtems_object_get_name``, which can be used RTEMS provides a helper routine, ``rtems_object_get_name``, which can be used
to obtain the name of any RTEMS object using just its ID. This routine to obtain the name of any RTEMS object using just its ID. This routine
@@ -150,10 +150,10 @@ prototyped as follows:
.. index:: get class from object ID .. index:: get class from object ID
.. index:: get node from object ID .. index:: get node from object ID
.. index:: get index from object ID .. index:: get index from object ID
.. index:: rtems_object_id_get_api .. index:: rtems_object_id_get_api()
.. index:: rtems_object_id_get_class .. index:: rtems_object_id_get_class()
.. index:: rtems_object_id_get_node .. index:: rtems_object_id_get_node()
.. index:: rtems_object_id_get_index .. index:: rtems_object_id_get_index()
.. code-block:: c .. code-block:: c

View File

@@ -9,7 +9,7 @@ Deprecated Directives
\clearpage \clearpage
.. index:: rtems_iterate_over_all_threads .. index:: rtems_iterate_over_all_threads()
.. _rtems_iterate_over_all_threads: .. _rtems_iterate_over_all_threads:

View File

@@ -160,8 +160,8 @@ It is important to note that the ``cpuset`` is not validated until the
``rtems_task_set_affinity`` call is made. At that point, it is validated ``rtems_task_set_affinity`` call is made. At that point, it is validated
against the current system configuration. against the current system configuration.
.. index:: rtems_task_get_note .. index:: rtems_task_get_note()
.. index:: rtems_task_set_note .. index:: rtems_task_set_note()
Transition Advice for Removed Notepads Transition Advice for Removed Notepads
--------------------------------------- ---------------------------------------
@@ -177,9 +177,9 @@ over the key (e.g. notepad index) selection. For most applications, POSIX Keys
should be used. These are available in all RTEMS build configurations. It is should be used. These are available in all RTEMS build configurations. It is
also possible that thread-local storage (TLS) is an option for some use cases. also possible that thread-local storage (TLS) is an option for some use cases.
.. index:: rtems_task_variable_add .. index:: rtems_task_variable_add()
.. index:: rtems_task_variable_get .. index:: rtems_task_variable_get()
.. index:: rtems_task_variable_delete .. index:: rtems_task_variable_delete()
Transition Advice for Removed Task Variables Transition Advice for Removed Task Variables
--------------------------------------------- ---------------------------------------------

View File

@@ -10,7 +10,7 @@ Removed Directives
\clearpage \clearpage
.. index:: get task notepad entry .. index:: get task notepad entry
.. index:: rtems_task_get_note .. index:: rtems_task_get_note()
.. _rtems_task_get_note: .. _rtems_task_get_note:
@@ -64,7 +64,7 @@ NOTES:
\clearpage \clearpage
.. index:: set task notepad entry .. index:: set task notepad entry
.. index:: rtems_task_set_note .. index:: rtems_task_set_note()
.. _rtems_task_set_note: .. _rtems_task_set_note:
@@ -119,7 +119,7 @@ NOTES:
.. index:: per-task variable .. index:: per-task variable
.. index:: task private variable .. index:: task private variable
.. index:: task private data .. index:: task private data
.. index:: rtems_task_variable_add .. index:: rtems_task_variable_add()
.. _rtems_task_variable_add: .. _rtems_task_variable_add:
@@ -182,7 +182,7 @@ NOTES:
.. index:: get per-task variable .. index:: get per-task variable
.. index:: obtain per-task variable .. index:: obtain per-task variable
.. index:: rtems_task_variable_get .. index:: rtems_task_variable_get()
.. _rtems_task_variable_get: .. _rtems_task_variable_get:
@@ -241,7 +241,7 @@ NOTES:
.. index:: per-task variable .. index:: per-task variable
.. index:: task private variable .. index:: task private variable
.. index:: task private data .. index:: task private data
.. index:: rtems_task_variable_delete .. index:: rtems_task_variable_delete()
.. _rtems_task_variable_delete: .. _rtems_task_variable_delete:

View File

@@ -125,7 +125,7 @@ sequence, related constants, usage, and status codes.
\clearpage \clearpage
.. index:: set struct timespec instance .. index:: set struct timespec instance
.. index:: rtems_timespec_set .. index:: rtems_timespec_set()
.. _rtems_timespec_set: .. _rtems_timespec_set:
@@ -156,7 +156,7 @@ NOTES:
\clearpage \clearpage
.. index:: rtems_timespec_zero .. index:: rtems_timespec_zero()
.. _rtems_timespec_zero: .. _rtems_timespec_zero:
@@ -184,7 +184,7 @@ NOTES:
\clearpage \clearpage
.. index:: rtems_timespec_is_valid .. index:: rtems_timespec_is_valid()
.. _rtems_timespec_is_valid: .. _rtems_timespec_is_valid:
@@ -214,7 +214,7 @@ NOTES:
\clearpage \clearpage
.. index:: rtems_timespec_add_to .. index:: rtems_timespec_add_to()
.. _rtems_timespec_add_to: .. _rtems_timespec_add_to:
@@ -244,7 +244,7 @@ NOTES:
\clearpage \clearpage
.. index:: rtems_timespec_subtract .. index:: rtems_timespec_subtract()
.. _rtems_timespec_subtract: .. _rtems_timespec_subtract:
@@ -279,7 +279,7 @@ NOTES:
\clearpage \clearpage
.. index:: rtems_timespec_divide .. index:: rtems_timespec_divide()
.. _rtems_timespec_divide: .. _rtems_timespec_divide:
@@ -320,7 +320,7 @@ NOTES:
\clearpage \clearpage
.. index:: rtems_timespec_divide_by_integer .. index:: rtems_timespec_divide_by_integer()
.. _rtems_timespec_divide_by_integer: .. _rtems_timespec_divide_by_integer:
@@ -352,7 +352,7 @@ NOTES:
\clearpage \clearpage
.. index:: rtems_timespec_less_than .. index:: rtems_timespec_less_than()
.. _rtems_timespec_less_than: .. _rtems_timespec_less_than:
@@ -383,7 +383,7 @@ NOTES:
\clearpage \clearpage
.. index:: rtems_timespec_greater_than .. index:: rtems_timespec_greater_than()
.. _rtems_timespec_greater_than: .. _rtems_timespec_greater_than:
@@ -412,7 +412,7 @@ NOTES:
\clearpage \clearpage
.. index:: rtems_timespec_equal_to .. index:: rtems_timespec_equal_to()
.. _rtems_timespec_equal_to: .. _rtems_timespec_equal_to:
@@ -441,7 +441,7 @@ NOTES:
\clearpage \clearpage
.. index:: rtems_timespec_get_seconds .. index:: rtems_timespec_get_seconds()
.. _rtems_timespec_get_seconds: .. _rtems_timespec_get_seconds:
@@ -470,7 +470,7 @@ NOTES:
\clearpage \clearpage
.. index:: rtems_timespec_get_nanoseconds .. index:: rtems_timespec_get_nanoseconds()
.. _rtems_timespec_get_nanoseconds: .. _rtems_timespec_get_nanoseconds:
@@ -499,7 +499,7 @@ NOTES:
\clearpage \clearpage
.. index:: rtems_timespec_to_ticks .. index:: rtems_timespec_to_ticks()
.. _rtems_timespec_to_ticks: .. _rtems_timespec_to_ticks:
@@ -527,7 +527,7 @@ NOTES:
\clearpage \clearpage
.. index:: rtems_timespec_from_ticks .. index:: rtems_timespec_from_ticks()
.. _rtems_timespec_from_ticks: .. _rtems_timespec_from_ticks:

View File

@@ -143,7 +143,7 @@ installed after the Standard C Library will operate correctly even if they
utilize the C Library because the C Library's thread delete extension is utilize the C Library because the C Library's thread delete extension is
invoked after that of the other thread delete extensions. invoked after that of the other thread delete extensions.
.. index:: rtems_task_create_extension .. index:: rtems_task_create_extension()
Thread Create Extension Thread Create Extension
----------------------- -----------------------