CheckVariableExists: Improve documentation

This uses the lowercase command signature and refactors the description
according to other similar documentation pages.
This commit is contained in:
Peter Kokot
2024-12-21 19:14:50 +01:00
parent 4559f5770f
commit e1723cab81

View File

@@ -7,19 +7,14 @@ CheckVariableExists
Check if the variable exists.
.. command:: CHECK_VARIABLE_EXISTS
.. command:: check_variable_exists
.. code-block:: cmake
CHECK_VARIABLE_EXISTS(VAR VARIABLE)
::
VAR - the name of the variable
VARIABLE - variable to store the result
Will be created as an internal cache variable.
check_variable_exists(<var> <variable>)
Check if the variable ``<var>`` exists and store the result in an internal
cache variable ``<variable>``.
This macro is only for ``C`` variables.