ソースを参照

Help: Use <xxx> for non-keyword arguments in property command signatures

Craig Scott 1 年間 前
コミット
29ccc9a4cd

+ 1 - 1
Help/command/get_target_property.rst

@@ -5,7 +5,7 @@ Get a property from a target.
 
 .. code-block:: cmake
 
-  get_target_property(<VAR> target property)
+  get_target_property(<VAR> <target> <property>)
 
 Get a property from a target.  The value of the property is stored in
 the variable ``<VAR>``.  If the target property is not found, the behavior

+ 5 - 5
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 <dir>] VAR)
+  get_test_property(<test> <property> [DIRECTORY <dir>] <VAR>)
 
 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 ``<VAR>``.  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
+``<VAR>`` 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, ``<VAR>`` will be set to
 an empty string.
 
 For a list of standard properties you can type

+ 3 - 2
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 <prop1> <value1> [<prop2> <value2>] ...)
 
-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.
 

+ 3 - 3
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(<targets> ...
+                        PROPERTIES <prop1> <value1>
+                        [<prop2> <value2>] ...)
 
 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

+ 3 - 1
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(<tests>...
+                       PROPERTIES <prop1> <value1>
+                       [<prop2> <value2>]...)
 
 Sets a property for the tests.  If the test is not found, CMake
 will report an error.