summaryrefslogtreecommitdiffstats
path: root/Source/cmFunctionCommand.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/cmFunctionCommand.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/cmFunctionCommand.h')
-rw-r--r--Source/cmFunctionCommand.h40
1 files changed, 0 insertions, 40 deletions
diff --git a/Source/cmFunctionCommand.h b/Source/cmFunctionCommand.h
index 0a029dc..a8bd3e7 100644
--- a/Source/cmFunctionCommand.h
+++ b/Source/cmFunctionCommand.h
@@ -59,46 +59,6 @@ public:
*/
virtual const char* GetName() const { return "function";}
- /**
- * Succinct documentation.
- */
- virtual const char* GetTerseDocumentation() const
- {
- return "Start recording a function for later invocation as a command.";
- }
-
- /**
- * More documentation.
- */
- virtual const char* GetFullDocumentation() const
- {
- return
- " function(<name> [arg1 [arg2 [arg3 ...]]])\n"
- " COMMAND1(ARGS ...)\n"
- " COMMAND2(ARGS ...)\n"
- " ...\n"
- " endfunction(<name>)\n"
- "Define a function named <name> that takes arguments named "
- "arg1 arg2 arg3 (...). Commands listed after function, but before "
- "the matching endfunction, are not invoked until the function "
- "is invoked. When it is invoked, the commands recorded in the "
- "function are first modified by replacing formal parameters (${arg1}) "
- "with the arguments passed, and then invoked as normal commands. In "
- "addition to referencing the formal parameters you can reference "
- "the variable ARGC which will be set to the number of arguments "
- "passed into the function as well as ARGV0 ARGV1 ARGV2 ... which "
- "will have the actual values of the arguments passed in. This "
- "facilitates creating functions with optional arguments. Additionally "
- "ARGV holds the list of all arguments given to the function and ARGN "
- "holds the list of arguments past the last expected argument."
- "\n"
- "A function opens a new scope: see set(var PARENT_SCOPE) for details."
- "\n"
- "See the cmake_policy() command documentation for the behavior of "
- "policies inside functions."
- ;
- }
-
cmTypeMacro(cmFunctionCommand, cmCommand);
};