diff options
author | Kitware Robot <kwrobot@kitware.com> | 2013-10-15 15:17:36 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-10-15 18:12:03 (GMT) |
commit | f051814ed0e63badbfd68049354f36259dbf4b49 (patch) | |
tree | f4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Help/command/define_property.rst | |
parent | e94958e99c4dec26c86ce8b76d744c04ba960675 (diff) | |
download | CMake-f051814ed0e63badbfd68049354f36259dbf4b49.zip CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.bz2 |
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation:
./convert-help.bash "/path/to/CMake-build/bin"
Then remove it.
Diffstat (limited to 'Help/command/define_property.rst')
-rw-r--r-- | Help/command/define_property.rst | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/Help/command/define_property.rst b/Help/command/define_property.rst new file mode 100644 index 0000000..62bcd1b --- /dev/null +++ b/Help/command/define_property.rst @@ -0,0 +1,45 @@ +define_property +--------------- + +Define and document custom properties. + +:: + + define_property(<GLOBAL | DIRECTORY | TARGET | SOURCE | + TEST | VARIABLE | CACHED_VARIABLE> + PROPERTY <name> [INHERITED] + BRIEF_DOCS <brief-doc> [docs...] + FULL_DOCS <full-doc> [docs...]) + +Define one property in a scope for use with the set_property and +get_property commands. This is primarily useful to associate +documentation with property names that may be retrieved with the +get_property command. The first argument determines the kind of scope +in which the property should be used. It must be one of the +following: + +:: + + GLOBAL = associated with the global namespace + DIRECTORY = associated with one directory + TARGET = associated with one target + SOURCE = associated with one source file + TEST = associated with a test named with add_test + VARIABLE = documents a CMake language variable + CACHED_VARIABLE = documents a CMake cache variable + +Note that unlike set_property and get_property no actual scope needs +to be given; only the kind of scope is important. + +The required PROPERTY option is immediately followed by the name of +the property being defined. + +If the INHERITED option then the get_property command will chain up to +the next higher scope when the requested property is not set in the +scope given to the command. DIRECTORY scope chains to GLOBAL. +TARGET, SOURCE, and TEST chain to DIRECTORY. + +The BRIEF_DOCS and FULL_DOCS options are followed by strings to be +associated with the property as its brief and full documentation. +Corresponding options to the get_property command will retrieve the +documentation. |