From d282bc462578a6e47747c78d2d42883530f0d11e Mon Sep 17 00:00:00 2001 From: Mark Griffiths Date: Fri, 1 Aug 2014 03:37:32 +0100 Subject: 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. --- doc_src/for.txt | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) (limited to 'doc_src/for.txt') 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 -for VARNAME in [VALUES...]; COMMANDS...; end +\fish{syn} +for VARNAME in [VALUES...]; COMMANDS...; end +\endfish \subsection for-description Description -for 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 - -for i in foo bar baz; echo $i; end - -would output: - -
+# would output:
 foo
 bar
 baz
-
+\endfish -- cgit v1.2.3