STYLE: fix bug 5682

This commit is contained in:
Ken Martin 2008-01-18 12:26:45 -05:00
parent 7c473d4828
commit f74c8cf0d8
1 changed files with 11 additions and 4 deletions

View File

@ -97,12 +97,19 @@ public:
"macro are first modified by replacing formal parameters (${arg1}) " "macro are first modified by replacing formal parameters (${arg1}) "
"with the arguments passed, and then invoked as normal commands. In " "with the arguments passed, and then invoked as normal commands. In "
"addition to referencing the formal parameters you can reference " "addition to referencing the formal parameters you can reference "
"the variable ARGC which will be set to the number of arguments " "the values ${ARGC} which will be set to the number of arguments "
"passed into the function as well as ARGV0 ARGV1 ARGV2 ... which " "passed into the function as well as ${ARGV0} ${ARGV1} ${ARGV2} "
"... which "
"will have the actual values of the arguments passed in. This " "will have the actual values of the arguments passed in. This "
"facilitates creating macros with optional arguments. Additionally " "facilitates creating macros with optional arguments. Additionally "
"ARGV holds the list of all arguments given to the macro and ARGN " "${ARGV} holds the list of all arguments given to the macro and "
"holds the list of argument pass the last expected argument."; "${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); cmTypeMacro(cmMacroCommand, cmCommand);