Commit b63ff2fb authored by Ken Martin's avatar Ken Martin

ENH: minor doc cleanups and an example of documenting a variable

parent c8e832dc
# # - Test for std:: namespace support
# check if the compiler supports std:: on stl classes
# CMAKE_NO_STD_NAMESPACE - defined by the results
# CMAKE_NO_ANSI_STRING_STREAM - defined by the results
#
IF("CMAKE_HAS_ANSI_STRING_STREAM" MATCHES "^CMAKE_HAS_ANSI_STRING_STREAM$")
MESSAGE(STATUS "Check for sstream")
......
......@@ -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 "
......
......@@ -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);
......
......@@ -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.");
}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment