summaryrefslogtreecommitdiffstats
path: root/Source/cmProjectCommand.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/cmProjectCommand.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/cmProjectCommand.h')
-rw-r--r--Source/cmProjectCommand.h35
1 files changed, 0 insertions, 35 deletions
diff --git a/Source/cmProjectCommand.h b/Source/cmProjectCommand.h
index 9547c4c..f7d086d 100644
--- a/Source/cmProjectCommand.h
+++ b/Source/cmProjectCommand.h
@@ -45,41 +45,6 @@ public:
*/
virtual const char* GetName() const {return "project";}
- /**
- * Succinct documentation.
- */
- virtual const char* GetTerseDocumentation() const
- {
- return "Set a name for the entire project.";
- }
-
- /**
- * More documentation.
- */
- virtual const char* GetFullDocumentation() const
- {
- return
- " project(<projectname> [languageName1 languageName2 ... ] )\n"
- "Sets the name of the project. "
- "Additionally this sets the variables <projectName>_BINARY_DIR and "
- "<projectName>_SOURCE_DIR to the respective values.\n"
- "Optionally you can specify which languages your project supports. "
- "Example languages are CXX (i.e. C++), C, Fortran, etc. "
- "By default C and CXX are enabled. E.g. if you do not have a "
- "C++ compiler, you can disable the check for it by explicitly listing "
- "the languages you want to support, e.g. C. By using the special "
- "language \"NONE\" all checks for any language can be disabled. "
- "If a variable exists called CMAKE_PROJECT_<projectName>_INCLUDE, "
- "the file pointed to by that variable will be included as the last step "
- "of the project command."
- "\n"
- "The top-level CMakeLists.txt file for a project must contain a "
- "literal, direct call to the project() command; loading one through "
- "the include() command is not sufficient. "
- "If no such call exists CMake will implicitly add one to the top that "
- "enables the default languages (C and CXX).";
- }
-
cmTypeMacro(cmProjectCommand, cmCommand);
};