summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2014-11-26 22:27:31 (GMT)
committerBrad King <brad.king@kitware.com>2014-12-01 13:47:58 (GMT)
commita1aceb2585cb4b1e4e58ac32d9435ed43ad2d1d2 (patch)
treee91affb22545af11f9ad5ab801b6f13a172036fd /Help/command
parent433c6d4689ca86f1a8d8d966be0204e98f95b968 (diff)
downloadCMake-a1aceb2585cb4b1e4e58ac32d9435ed43ad2d1d2.zip
CMake-a1aceb2585cb4b1e4e58ac32d9435ed43ad2d1d2.tar.gz
CMake-a1aceb2585cb4b1e4e58ac32d9435ed43ad2d1d2.tar.bz2
Help: Format set_property and get_property command docs
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/get_property.rst38
-rw-r--r--Help/command/set_property.rst32
2 files changed, 42 insertions, 28 deletions
diff --git a/Help/command/get_property.rst b/Help/command/get_property.rst
index c2937be..abec8f9 100644
--- a/Help/command/get_property.rst
+++ b/Help/command/get_property.rst
@@ -21,29 +21,37 @@ specifies the variable in which to store the result. The second
argument determines the scope from which to get the property. It must
be one of the following:
-GLOBAL scope is unique and does not accept a name.
+``GLOBAL``
+ Scope is unique and does not accept a name.
-DIRECTORY scope defaults to the current directory but another
-directory (already processed by CMake) may be named by full or
-relative path.
+``DIRECTORY``
+ Scope defaults to the current directory but another
+ directory (already processed by CMake) may be named by full or
+ relative path.
-TARGET scope must name one existing target.
+``TARGET``
+ Scope must name one existing target.
-SOURCE scope must name one source file.
+``SOURCE``
+ Scope must name one source file.
-TEST scope must name one existing test.
+``TEST``
+ Scope must name one existing test.
-CACHE scope must name one cache entry.
+``CACHE``
+ Scope must name one cache entry.
-VARIABLE scope is unique and does not accept a name.
+``VARIABLE``
+ Scope is unique and does not accept a name.
-The required PROPERTY option is immediately followed by the name of
+The required ``PROPERTY`` option is immediately followed by the name of
the property to get. If the property is not set an empty value is
-returned. If the SET option is given the variable is set to a boolean
-value indicating whether the property has been set. If the DEFINED
+returned. If the ``SET`` option is given the variable is set to a boolean
+value indicating whether the property has been set. If the ``DEFINED``
option is given the variable is set to a boolean value indicating
-whether the property has been defined such as with define_property.
-If BRIEF_DOCS or FULL_DOCS is given then the variable is set to a
+whether the property has been defined such as with the
+:command:`define_property` command.
+If ``BRIEF_DOCS`` or ``FULL_DOCS`` is given then the variable is set to a
string containing documentation for the requested property. If
documentation is requested for a property that has not been defined
-NOTFOUND is returned.
+``NOTFOUND`` is returned.
diff --git a/Help/command/set_property.rst b/Help/command/set_property.rst
index 8cb963e..8c4f610 100644
--- a/Help/command/set_property.rst
+++ b/Help/command/set_property.rst
@@ -18,26 +18,32 @@ Set one property on zero or more objects of a scope. The first
argument determines the scope in which the property is set. It must
be one of the following:
-GLOBAL scope is unique and does not accept a name.
+``GLOBAL``
+ Scope is unique and does not accept a name.
-DIRECTORY scope defaults to the current directory but another
-directory (already processed by CMake) may be named by full or
-relative path.
+``DIRECTORY``
+ Scope defaults to the current directory but another
+ directory (already processed by CMake) may be named by full or
+ relative path.
-TARGET scope may name zero or more existing targets.
+``TARGET``
+ Scope may name zero or more existing targets.
-SOURCE scope may name zero or more source files. Note that source
-file properties are visible only to targets added in the same
-directory (CMakeLists.txt).
+``SOURCE``
+ Scope may name zero or more source files. Note that source
+ file properties are visible only to targets added in the same
+ directory (CMakeLists.txt).
-TEST scope may name zero or more existing tests.
+``TEST``
+ Scope may name zero or more existing tests.
-CACHE scope must name zero or more cache existing entries.
+``CACHE``
+ Scope must name zero or more cache existing entries.
-The required PROPERTY option is immediately followed by the name of
+The required ``PROPERTY`` option is immediately followed by the name of
the property to set. Remaining arguments are used to compose the
property value in the form of a semicolon-separated list. If the
-APPEND option is given the list is appended to any existing property
-value.If the APPEND_STRING option is given the string is append to any
+``APPEND`` option is given the list is appended to any existing property
+value. If the ``APPEND_STRING`` option is given the string is append to any
existing property value as string, i.e. it results in a longer string
and not a list of strings.