diff options
author | Ken Martin <ken.martin@kitware.com> | 2007-10-15 18:50:18 (GMT) |
---|---|---|
committer | Ken Martin <ken.martin@kitware.com> | 2007-10-15 18:50:18 (GMT) |
commit | b63ff2fb6f9e73c4d909c4b7fd5d07b25f916ce3 (patch) | |
tree | 89ba9f500e1b779e2e07abc40a57aa32b8bc4ff6 /Source | |
parent | c8e832dcf5d1477192e19bf521f684c953d7751d (diff) | |
download | CMake-b63ff2fb6f9e73c4d909c4b7fd5d07b25f916ce3.zip CMake-b63ff2fb6f9e73c4d909c4b7fd5d07b25f916ce3.tar.gz CMake-b63ff2fb6f9e73c4d909c4b7fd5d07b25f916ce3.tar.bz2 |
ENH: minor doc cleanups and an example of documenting a variable
Diffstat (limited to 'Source')
-rw-r--r-- | Source/cmForEachCommand.h | 6 | ||||
-rw-r--r-- | Source/cmWhileCommand.h | 2 | ||||
-rw-r--r-- | Source/cmake.cxx | 12 |
3 files changed, 16 insertions, 4 deletions
diff --git a/Source/cmForEachCommand.h b/Source/cmForEachCommand.h index 115c522..0e21094 100644 --- a/Source/cmForEachCommand.h +++ b/Source/cmForEachCommand.h @@ -93,11 +93,11 @@ public: " COMMAND1(ARGS ...)\n" " COMMAND2(ARGS ...)\n" " ...\n" - " ENDforeach(loop_var)\n" + " endforeach(loop_var)\n" " foreach(loop_var RANGE total)\n" " foreach(loop_var RANGE start stop [step])\n" - "All commands between foreach and the matching ENDforeach are recorded " - "without being invoked. Once the ENDforeach is evaluated, the " + "All commands between foreach and the matching endforeach are recorded " + "without being invoked. Once the endforeach is evaluated, the " "recorded list of commands is invoked once for each argument listed " "in the original foreach command. Before each iteration of the loop " "\"${loop_var}\" will be set as a variable with " diff --git a/Source/cmWhileCommand.h b/Source/cmWhileCommand.h index d52e21a..cff9f5a 100644 --- a/Source/cmWhileCommand.h +++ b/Source/cmWhileCommand.h @@ -104,7 +104,7 @@ public: "without being invoked. Once the endwhile is evaluated, the " "recorded list of commands is invoked as long as the condition " "is true. The condition is evaulated using the same logic as the " - "IF command."; + "if command."; } cmTypeMacro(cmWhileCommand, cmCommand); diff --git a/Source/cmake.cxx b/Source/cmake.cxx index d6dd6a6..6f96bd0 100644 --- a/Source/cmake.cxx +++ b/Source/cmake.cxx @@ -3076,6 +3076,18 @@ void cmake::DefineProperties(cmake *cm) "List of packages which were not found during the CMake run.", "List of packages which were not found during the CMake run. Whether a " "package has been found is determined using the <NAME>_FOUND variables."); + + + // ================================================================ + // define variables as well + // ================================================================ + + cm->DefineProperty + ("CMAKE_COMMAND", cmProperty::VARIABLE, + "The full path to the cmake executable.", + "This is the full path to the CMake executable cmake which is " + "useful from custom commands that want to use the cmake -E " + "option for portable system commands."); } |