Help: Use signature directive for cmake_language command

This commit is contained in:
Matthew Woehlke
2023-02-27 11:08:32 -05:00
committed by Brad King
parent 74e3c1d313
commit cd33f461a6
+8 -21
View File
@@ -27,10 +27,7 @@ those created via the :command:`macro` or :command:`function` commands.
Calling Commands Calling Commands
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
.. _CALL: .. signature::
.. code-block:: cmake
cmake_language(CALL <command> [<arg>...]) cmake_language(CALL <command> [<arg>...])
Calls the named ``<command>`` with the given arguments (if any). Calls the named ``<command>`` with the given arguments (if any).
@@ -60,11 +57,9 @@ is equivalent to
Evaluating Code Evaluating Code
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
.. _EVAL: .. signature::
.. code-block:: cmake
cmake_language(EVAL CODE <code>...) cmake_language(EVAL CODE <code>...)
:target: EVAL
Evaluates the ``<code>...`` as CMake code. Evaluates the ``<code>...`` as CMake code.
@@ -109,10 +104,7 @@ Deferring Calls
.. versionadded:: 3.19 .. versionadded:: 3.19
.. _DEFER: .. signature::
.. code-block:: cmake
cmake_language(DEFER <options>... CALL <command> [<arg>...]) cmake_language(DEFER <options>... CALL <command> [<arg>...])
Schedules a call to the named ``<command>`` with the given arguments (if any) Schedules a call to the named ``<command>`` with the given arguments (if any)
@@ -157,8 +149,8 @@ Lists>` of deferred call ids. The ids are for the directory scope in which
the calls have been deferred to (i.e. where they will be executed), which can the calls have been deferred to (i.e. where they will be executed), which can
be different to the scope in which they were created. The ``DIRECTORY`` be different to the scope in which they were created. The ``DIRECTORY``
option can be used to specify the scope for which to retrieve the call ids. option can be used to specify the scope for which to retrieve the call ids.
If that option is not given, the call ids for the current directory scope will If that option is not given, the call ids for the current directory scope
be returned. will be returned.
Details of a specific call may be retrieved from its id: Details of a specific call may be retrieved from its id:
@@ -229,8 +221,6 @@ also prints::
Deferred Message 1 Deferred Message 1
Deferred Message 2 Deferred Message 2
.. _SET_DEPENDENCY_PROVIDER:
.. _dependency_providers: .. _dependency_providers:
Dependency Providers Dependency Providers
@@ -241,8 +231,7 @@ Dependency Providers
.. note:: A high-level introduction to this feature can be found in the .. note:: A high-level introduction to this feature can be found in the
:ref:`Using Dependencies Guide <dependency_providers_overview>`. :ref:`Using Dependencies Guide <dependency_providers_overview>`.
.. code-block:: cmake .. signature::
cmake_language(SET_DEPENDENCY_PROVIDER <command> cmake_language(SET_DEPENDENCY_PROVIDER <command>
SUPPORTED_METHODS <methods>...) SUPPORTED_METHODS <methods>...)
@@ -499,11 +488,9 @@ Getting current message log level
.. versionadded:: 3.25 .. versionadded:: 3.25
.. _GET_MESSAGE_LOG_LEVEL:
.. _query_message_log_level: .. _query_message_log_level:
.. code-block:: cmake .. signature::
cmake_language(GET_MESSAGE_LOG_LEVEL <output_variable>) cmake_language(GET_MESSAGE_LOG_LEVEL <output_variable>)
Writes the current :command:`message` logging level Writes the current :command:`message` logging level