summaryrefslogtreecommitdiffstats
path: root/Source/cmMacroCommand.h
diff options
context:
space:
mode:
authorKen Martin <ken.martin@kitware.com>2008-01-18 17:26:45 (GMT)
committerKen Martin <ken.martin@kitware.com>2008-01-18 17:26:45 (GMT)
commitf74c8cf0d87337f3a2f66a2c0b8ed682ad5b9e5c (patch)
tree977bbe8951d1d8e73444a9313f6adfc9b874a4b2 /Source/cmMacroCommand.h
parent7c473d482824cb251db0213955b36f1d391120a1 (diff)
downloadCMake-f74c8cf0d87337f3a2f66a2c0b8ed682ad5b9e5c.zip
CMake-f74c8cf0d87337f3a2f66a2c0b8ed682ad5b9e5c.tar.gz
CMake-f74c8cf0d87337f3a2f66a2c0b8ed682ad5b9e5c.tar.bz2
STYLE: fix bug 5682
Diffstat (limited to 'Source/cmMacroCommand.h')
-rw-r--r--Source/cmMacroCommand.h15
1 files changed, 11 insertions, 4 deletions
diff --git a/Source/cmMacroCommand.h b/Source/cmMacroCommand.h
index f0df9c4..01396c3 100644
--- a/Source/cmMacroCommand.h
+++ b/Source/cmMacroCommand.h
@@ -97,12 +97,19 @@ public:
"macro 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 "
+ "the values ${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 macros with optional arguments. Additionally "
- "ARGV holds the list of all arguments given to the macro and ARGN "
- "holds the list of argument pass the last expected argument.";
+ "${ARGV} holds the list of all arguments given to the macro and "
+ "${ARGN} "
+ "holds the list of argument pass the last expected argument. "
+ "Note that the parameters to a macro and values such as ARGN "
+ "are not variables in the usual CMake sense. They are string "
+ "replacements much like the c preprocessor would do with a "
+ "macro. If you want true CMake variables you should look at "
+ "the function command.";
}
cmTypeMacro(cmMacroCommand, cmCommand);