Commit Graph

10 Commits

Author SHA1 Message Date
Craig Scott
b82526c654 Help: Minor grammar and typo corrections for macro command docs
Follow-up to !2616, specifically commit 22cca9b810
2018-11-16 08:01:55 +11:00
Joachim Wuttke (l)
22cca9b810 Help: describe differences between macro and function. 2018-11-14 21:56:23 +01:00
Joachim Wuttke (l)
b90ae70a3b Help: in macro vs function example, use lowercase names.
Follow our own advise not to change cases.

Omit the leading underscore.
2018-11-14 20:33:12 +01:00
Joachim Wuttke (l)
357cdee3a1 Help: Document that macro invocation is case-insensitive 2018-11-13 13:47:24 -05:00
Joachim Wuttke (l)
dcf11cbcdc Help: Mention endmacro argument as legacy only.
Same change as previously done for function, if, while, ...
2018-11-13 12:14:55 +01:00
Joachim Wuttke (l)
c2efb3efcd Help: Revise docs on Scripting Commands
Revise docs for all "Scripting Commands", except four find_XXX
that use a macro suite of their own.

* Take full advantage of the improved syntax highlighting.
* Make consequential use of <..> placeholders.
* Clarify things here and there in the text.

Specific improvements to some command docs:

* "math": Correct description of novel hexadecimal capability.
* "if", "foreach", "while": Provide link to "endif" etc
* "foreach", "while": Mention "break" and "continue".
* "foreach": Simplify explanation of ``RANGE`` and ``IN`` signatures;
   advise against negative arguments or reverse ranges (compare issue #18461)
* "endif", "endfunction" etc: Explain that the argument is optional and
   maintained for compatibility only
2018-10-23 15:12:10 +02:00
Daniele E. Domenichelli
4efef3f775 Help: Clarify that ARGV# beyond ARGC will have an undefined behavior (#15380) 2015-02-26 17:42:30 +01:00
Daniele E. Domenichelli
e3363bfbec Help: Refine the .rst formatting of macro and function documentation 2015-02-26 17:19:52 +01:00
Daniele E. Domenichelli
f0db2e3898 Help: Document macro argument caveats in more detail
Add notes about macro arguments in the foreach, if, and list commands.
Add a section to the macro command documentation explaining in detail
how macro arguments are not variables.
2013-11-19 09:01:54 -05:00
Kitware Robot
f051814ed0 Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation:

 ./convert-help.bash "/path/to/CMake-build/bin"

Then remove it.
2013-10-15 14:12:03 -04:00