summaryrefslogtreecommitdiffstats
path: root/Source/cmMessageCommand.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/cmMessageCommand.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/cmMessageCommand.h')
-rw-r--r--Source/cmMessageCommand.h41
1 files changed, 0 insertions, 41 deletions
diff --git a/Source/cmMessageCommand.h b/Source/cmMessageCommand.h
index a053bdd..fec9a32 100644
--- a/Source/cmMessageCommand.h
+++ b/Source/cmMessageCommand.h
@@ -46,47 +46,6 @@ public:
*/
virtual bool IsScriptable() const { return true; }
- /**
- * Succinct documentation.
- */
- virtual const char* GetTerseDocumentation() const
- {
- return "Display a message to the user.";
- }
-
- /**
- * More documentation.
- */
- virtual const char* GetFullDocumentation() const
- {
- return
- " message([<mode>] \"message to display\" ...)\n"
- "The optional <mode> keyword determines the type of message:\n"
- " (none) = Important information\n"
- " STATUS = Incidental information\n"
- " WARNING = CMake Warning, continue processing\n"
- " AUTHOR_WARNING = CMake Warning (dev), continue processing\n"
- " SEND_ERROR = CMake Error, continue processing,\n"
- " but skip generation\n"
- " FATAL_ERROR = CMake Error, stop processing and generation\n"
- " DEPRECATION = CMake Deprecation Error or Warning if variable\n"
- " CMAKE_ERROR_DEPRECATED or CMAKE_WARN_DEPRECATED\n"
- " is enabled, respectively, else no message.\n"
- "The CMake command-line tool displays STATUS messages on stdout "
- "and all other message types on stderr. "
- "The CMake GUI displays all messages in its log area. "
- "The interactive dialogs (ccmake and CMakeSetup) show STATUS messages "
- "one at a time on a status line and other messages in interactive "
- "pop-up boxes."
- "\n"
- "CMake Warning and Error message text displays using a simple "
- "markup language. "
- "Non-indented text is formatted in line-wrapped paragraphs delimited "
- "by newlines. "
- "Indented text is considered pre-formatted."
- ;
- }
-
cmTypeMacro(cmMessageCommand, cmCommand);
};