浏览代码

Help: Format set_property and get_property command docs

Brad King 11 年之前
父节点
当前提交
a1aceb2585
共有 2 个文件被更改,包括 42 次插入28 次删除
  1. 23 15
      Help/command/get_property.rst
  2. 19 13
      Help/command/set_property.rst

+ 23 - 15
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
 argument determines the scope from which to get the property.  It must
 be one of the following:
 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
 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
 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
 string containing documentation for the requested property.  If
 documentation is requested for a property that has not been defined
 documentation is requested for a property that has not been defined
-NOTFOUND is returned.
+``NOTFOUND`` is returned.

+ 19 - 13
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
 argument determines the scope in which the property is set.  It must
 be one of the following:
 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
 the property to set.  Remaining arguments are used to compose the
 property value in the form of a semicolon-separated list.  If 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
 existing property value as string, i.e.  it results in a longer string
 and not a list of strings.
 and not a list of strings.