diff options
author | Brad King <brad.king@kitware.com> | 2014-11-26 22:27:31 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2014-12-01 13:47:58 (GMT) |
commit | a1aceb2585cb4b1e4e58ac32d9435ed43ad2d1d2 (patch) | |
tree | e91affb22545af11f9ad5ab801b6f13a172036fd /Help/command/get_property.rst | |
parent | 433c6d4689ca86f1a8d8d966be0204e98f95b968 (diff) | |
download | CMake-a1aceb2585cb4b1e4e58ac32d9435ed43ad2d1d2.zip CMake-a1aceb2585cb4b1e4e58ac32d9435ed43ad2d1d2.tar.gz CMake-a1aceb2585cb4b1e4e58ac32d9435ed43ad2d1d2.tar.bz2 |
Help: Format set_property and get_property command docs
Diffstat (limited to 'Help/command/get_property.rst')
-rw-r--r-- | Help/command/get_property.rst | 38 |
1 files changed, 23 insertions, 15 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. |