diff options
| author |  Mark Griffiths <mark@thebespokepixel.com> | 2014-08-01 03:37:32 +0100 |
|---|---|---|
| committer | Mark Griffiths <mark@thebespokepixel.com> | 2014-09-03 14:43:24 +0100 |
| commit | d282bc462578a6e47747c78d2d42883530f0d11e (patch) | |
| tree | a6515e908d4fc1c400cb6cebaf79b1590b005804 /doc_src/for.txt | |
| parent | 1c4223889bd729ee83aa21a3450dc28f92ade641 (diff) | |
Documentation update
Rework for Doxygen >1.8. Moved large parts of the documentation to a
simplified format, making use of Markdown enhancements and fixing bad
long options.
Diffstat (limited to 'doc_src/for.txt')
| -rw-r--r-- | doc_src/for.txt | 22 |
1 files changed, 10 insertions, 12 deletions
diff --git a/doc_src/for.txt b/doc_src/for.txt index 67a46fc3..902f4495 100644 --- a/doc_src/for.txt +++ b/doc_src/for.txt @@ -1,25 +1,23 @@ \section for for - perform a set of commands multiple times. \subsection for-synopsis Synopsis -<tt>for VARNAME in [VALUES...]; COMMANDS...; end</tt> +\fish{syn} +for VARNAME in [VALUES...]; COMMANDS...; end +\endfish \subsection for-description Description -<tt>for</tt> is a loop construct. It will perform the commands specified by -\c COMMANDS multiple times. On each iteration, the environment variable specified by -\c VARNAME is assigned a new value from \c VALUES. If \c VALUES is empty, \c COMMANDS will +`for` is a loop construct. It will perform the commands specified by +`COMMANDS` multiple times. On each iteration, the environment variable specified by +`VARNAME` is assigned a new value from `VALUES`. If `VALUES` is empty, `COMMANDS` will not be executed at all. \subsection for-example Example +\fish +for i in foo bar baz; echo $i; end -The command - -<tt>for i in foo bar baz; echo $i; end</tt> - -would output: - -<pre> +# would output: foo bar baz -</pre> +\endfish |