From 29ccc9a4cd2d22553ab387d30c6eada15f25fb3e Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Fri, 5 Jan 2024 15:31:39 +1100 Subject: Help: Use for non-keyword arguments in property command signatures --- Help/command/get_target_property.rst | 2 +- Help/command/get_test_property.rst | 10 +++++----- Help/command/set_directory_properties.rst | 5 +++-- Help/command/set_target_properties.rst | 6 +++--- Help/command/set_tests_properties.rst | 4 +++- 5 files changed, 15 insertions(+), 12 deletions(-) diff --git a/Help/command/get_target_property.rst b/Help/command/get_target_property.rst index 8c6dcb1..20027ee 100644 --- a/Help/command/get_target_property.rst +++ b/Help/command/get_target_property.rst @@ -5,7 +5,7 @@ Get a property from a target. .. code-block:: cmake - get_target_property( target property) + get_target_property( ) Get a property from a target. The value of the property is stored in the variable ````. If the target property is not found, the behavior diff --git a/Help/command/get_test_property.rst b/Help/command/get_test_property.rst index 1fcf24e..08ddd4e 100644 --- a/Help/command/get_test_property.rst +++ b/Help/command/get_test_property.rst @@ -5,15 +5,15 @@ Get a property of the test. .. code-block:: cmake - get_test_property(test property [DIRECTORY ] VAR) + get_test_property( [DIRECTORY ] ) Get a property from the test. The value of the property is stored in -the variable ``VAR``. If the test property is not found, the behavior +the variable ````. If the test property is not found, the behavior depends on whether it has been defined to be an ``INHERITED`` property -or not (see :command:`define_property`). Non-inherited properties will -set ``VAR`` to "NOTFOUND", whereas inherited properties will search the +or not (see :command:`define_property`). Non-inherited properties will set +```` to ``NOTFOUND``, whereas inherited properties will search the relevant parent scope as described for the :command:`define_property` -command and if still unable to find the property, ``VAR`` will be set to +command and if still unable to find the property, ```` will be set to an empty string. For a list of standard properties you can type diff --git a/Help/command/set_directory_properties.rst b/Help/command/set_directory_properties.rst index 93ad39b..6d94808 100644 --- a/Help/command/set_directory_properties.rst +++ b/Help/command/set_directory_properties.rst @@ -5,9 +5,10 @@ Set properties of the current directory and subdirectories. .. code-block:: cmake - set_directory_properties(PROPERTIES prop1 value1 [prop2 value2] ...) + set_directory_properties(PROPERTIES [ ] ...) -Sets properties of the current directory and its subdirectories in key-value pairs. +Sets properties of the current directory and its subdirectories in key-value +pairs. See also the :command:`set_property(DIRECTORY)` command. diff --git a/Help/command/set_target_properties.rst b/Help/command/set_target_properties.rst index 874788b..5357575 100644 --- a/Help/command/set_target_properties.rst +++ b/Help/command/set_target_properties.rst @@ -5,9 +5,9 @@ Targets can have properties that affect how they are built. .. code-block:: cmake - set_target_properties(target1 target2 ... - PROPERTIES prop1 value1 - prop2 value2 ...) + set_target_properties( ... + PROPERTIES + [ ] ...) Sets properties on targets. The syntax for the command is to list all the targets you want to change, and then provide the values you want to diff --git a/Help/command/set_tests_properties.rst b/Help/command/set_tests_properties.rst index da750e3..8eac0e2 100644 --- a/Help/command/set_tests_properties.rst +++ b/Help/command/set_tests_properties.rst @@ -5,7 +5,9 @@ Set a property of the tests. .. code-block:: cmake - set_tests_properties(test1 [test2...] PROPERTIES prop1 value1 prop2 value2) + set_tests_properties(... + PROPERTIES + [ ]...) Sets a property for the tests. If the test is not found, CMake will report an error. -- cgit v0.12