summaryrefslogtreecommitdiffstats
path: root/Source/cmDefinePropertyCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-09-17 17:23:40 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-16 13:22:36 (GMT)
commite33d8d2d7799271e94b4f1215c77d6a685f82b88 (patch)
tree03726a7dacd9c06731de417d3f8c82f7bbb5e8f1 /Source/cmDefinePropertyCommand.h
parent399e9c46d88c12507f1a762e69225c5ab9f4ac08 (diff)
downloadCMake-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/cmDefinePropertyCommand.h')
-rw-r--r--Source/cmDefinePropertyCommand.h47
1 files changed, 0 insertions, 47 deletions
diff --git a/Source/cmDefinePropertyCommand.h b/Source/cmDefinePropertyCommand.h
index b5175d5..8dc4d96 100644
--- a/Source/cmDefinePropertyCommand.h
+++ b/Source/cmDefinePropertyCommand.h
@@ -34,53 +34,6 @@ public:
*/
virtual const char* GetName() const { return "define_property";}
- /**
- * Succinct documentation.
- */
- virtual const char* GetTerseDocumentation() const
- {
- return "Define and document custom properties.";
- }
-
- /**
- * Longer documentation.
- */
- virtual const char* GetFullDocumentation() const
- {
- return
- " define_property(<GLOBAL | DIRECTORY | TARGET | SOURCE |\n"
- " TEST | VARIABLE | CACHED_VARIABLE>\n"
- " PROPERTY <name> [INHERITED]\n"
- " BRIEF_DOCS <brief-doc> [docs...]\n"
- " FULL_DOCS <full-doc> [docs...])\n"
- "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:\n"
- " GLOBAL = associated with the global namespace\n"
- " DIRECTORY = associated with one directory\n"
- " TARGET = associated with one target\n"
- " SOURCE = associated with one source file\n"
- " TEST = associated with a test named with add_test\n"
- " VARIABLE = documents a CMake language variable\n"
- " CACHED_VARIABLE = documents a CMake cache variable\n"
- "Note that unlike set_property and get_property no actual scope "
- "needs to be given; only the kind of scope is important.\n"
- "The required PROPERTY option is immediately followed by the name "
- "of the property being defined.\n"
- "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.\n"
- "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.";
- }
-
cmTypeMacro(cmDefinePropertyCommand, cmCommand);
private:
std::string PropertyName;