diff options
author | Brad King <brad.king@kitware.com> | 2013-09-17 17:23:40 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-10-16 13:22:36 (GMT) |
commit | e33d8d2d7799271e94b4f1215c77d6a685f82b88 (patch) | |
tree | 03726a7dacd9c06731de417d3f8c82f7bbb5e8f1 /Source/cmGetPropertyCommand.h | |
parent | 399e9c46d88c12507f1a762e69225c5ab9f4ac08 (diff) | |
download | CMake-e33d8d2d7799271e94b4f1215c77d6a685f82b88.zip CMake-e33d8d2d7799271e94b4f1215c77d6a685f82b88.tar.gz CMake-e33d8d2d7799271e94b4f1215c77d6a685f82b88.tar.bz2 |
Drop builtin command documentation
Drop all GetTerseDocumentation and GetFullDocumentation methods from
commands. The command documentation is now in Help/command/*.rst files.
Diffstat (limited to 'Source/cmGetPropertyCommand.h')
-rw-r--r-- | Source/cmGetPropertyCommand.h | 52 |
1 files changed, 0 insertions, 52 deletions
diff --git a/Source/cmGetPropertyCommand.h b/Source/cmGetPropertyCommand.h index 3c597fd..e1630ff 100644 --- a/Source/cmGetPropertyCommand.h +++ b/Source/cmGetPropertyCommand.h @@ -41,58 +41,6 @@ public: */ virtual const char* GetName() const { return "get_property";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get a property."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " get_property(<variable>\n" - " <GLOBAL |\n" - " DIRECTORY [dir] |\n" - " TARGET <target> |\n" - " SOURCE <source> |\n" - " TEST <test> |\n" - " CACHE <entry> |\n" - " VARIABLE>\n" - " PROPERTY <name>\n" - " [SET | DEFINED | BRIEF_DOCS | FULL_DOCS])\n" - "Get one property from one object in a scope. " - "The first argument 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:\n" - "GLOBAL scope is unique and does not accept a name.\n" - "DIRECTORY scope defaults to the current directory but another " - "directory (already processed by CMake) may be named by full or " - "relative path.\n" - "TARGET scope must name one existing target.\n" - "SOURCE scope must name one source file.\n" - "TEST scope must name one existing test.\n" - "CACHE scope must name one cache entry.\n" - "VARIABLE scope is unique and does not accept a name.\n" - "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 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 string containing documentation for the requested property. " - "If documentation is requested for a property that has not been " - "defined NOTFOUND is returned."; - } - cmTypeMacro(cmGetPropertyCommand, cmCommand); private: enum OutType { OutValue, OutDefined, OutBriefDoc, OutFullDoc, OutSet }; |