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/cmReturnCommand.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/cmReturnCommand.h')
-rw-r--r-- | Source/cmReturnCommand.h | 26 |
1 files changed, 0 insertions, 26 deletions
diff --git a/Source/cmReturnCommand.h b/Source/cmReturnCommand.h index a6e87ef..2822b62 100644 --- a/Source/cmReturnCommand.h +++ b/Source/cmReturnCommand.h @@ -47,32 +47,6 @@ public: */ virtual const char* GetName() const {return "return";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Return from a file, directory or function."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " return()\n" - "Returns from a file, directory or function. When this command is " - "encountered in an included file (via include() or find_package()), " - "it causes processing of the current file to stop and control is " - "returned to the including file. If it is encountered in a file which " - "is not included by another file, e.g. a CMakeLists.txt, control is " - "returned to the parent directory if there is one. " - "If return is called in a function, control is returned to the caller " - "of the function. Note that a macro " - "is not a function and does not handle return like a function does."; - } - cmTypeMacro(cmReturnCommand, cmCommand); }; |