summaryrefslogtreecommitdiffstats
path: root/Source/cmMacroCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2003-02-14 23:47:16 (GMT)
committerBrad King <brad.king@kitware.com>2003-02-14 23:47:16 (GMT)
commita02574158d178615cf8fd642695e5099b6041049 (patch)
treedf9f52770e9c2ff771988ae1a91ec0b2287548da /Source/cmMacroCommand.h
parentdec0b5106611cbccd1f75c1fa3371d66bdd69a47 (diff)
downloadCMake-a02574158d178615cf8fd642695e5099b6041049.zip
CMake-a02574158d178615cf8fd642695e5099b6041049.tar.gz
CMake-a02574158d178615cf8fd642695e5099b6041049.tar.bz2
ENH: Cleaned up documentation and formatted it for use by cmDocumentation.
Diffstat (limited to 'Source/cmMacroCommand.h')
-rw-r--r--Source/cmMacroCommand.h14
1 files changed, 12 insertions, 2 deletions
diff --git a/Source/cmMacroCommand.h b/Source/cmMacroCommand.h
index e090ec7..4a0c95b 100644
--- a/Source/cmMacroCommand.h
+++ b/Source/cmMacroCommand.h
@@ -78,7 +78,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
- return "start defining a Macro.";
+ return "Start recording a macro for later invocation as a command.";
}
/**
@@ -87,7 +87,17 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "MACRO(name arg1 arg2 arg3 ...) Starts to define a macro named name that takes arguments named arg1 arg2 arg3... When the macro is invoked the actual arguments passed replace the formal arguments. ";
+ " MACRO(<name> [arg1 [arg2 [arg3 ...]]])\n"
+ " COMMAND1(ARGS ...)\n"
+ " COMMAND2(ARGS ...)\n"
+ " ...\n"
+ " ENDMACRO(<name>)\n"
+ "Define a macro named <name> that takes arguments named "
+ "arg1 arg2 arg3 (...). Commands listed after MACRO, "
+ "but before the matching ENDMACRO, are not invoked until the macro "
+ "is invoked. When it is invoked, the commands recorded in the "
+ "macro are first modified by replacing formal parameters (${arg1}) with "
+ "the arguments passed, and then invoked as normal commands.";
}
cmTypeMacro(cmMacroCommand, cmCommand);