summaryrefslogtreecommitdiffstats
path: root/Source/cmWhileCommand.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/cmWhileCommand.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/cmWhileCommand.h')
-rw-r--r--Source/cmWhileCommand.h26
1 files changed, 0 insertions, 26 deletions
diff --git a/Source/cmWhileCommand.h b/Source/cmWhileCommand.h
index 1bdf27a..45badd0 100644
--- a/Source/cmWhileCommand.h
+++ b/Source/cmWhileCommand.h
@@ -68,32 +68,6 @@ public:
*/
virtual const char* GetName() const { return "while";}
- /**
- * Succinct documentation.
- */
- virtual const char* GetTerseDocumentation() const
- {
- return "Evaluate a group of commands while a condition is true";
- }
-
- /**
- * More documentation.
- */
- virtual const char* GetFullDocumentation() const
- {
- return
- " while(condition)\n"
- " COMMAND1(ARGS ...)\n"
- " COMMAND2(ARGS ...)\n"
- " ...\n"
- " endwhile(condition)\n"
- "All commands between while and the matching endwhile are recorded "
- "without being invoked. Once the endwhile is evaluated, the "
- "recorded list of commands is invoked as long as the condition "
- "is true. The condition is evaluated using the same logic as the "
- "if command.";
- }
-
cmTypeMacro(cmWhileCommand, cmCommand);
};