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/break.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/break.txt')
| -rw-r--r-- | doc_src/break.txt | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/doc_src/break.txt b/doc_src/break.txt index 3f46bb8c..3109fe9c 100644 --- a/doc_src/break.txt +++ b/doc_src/break.txt @@ -1,22 +1,25 @@ \section break break - stop the current inner loop \subsection break-synopsis Synopsis - <tt>LOOP_CONSTRUCT; [COMMANDS...] break; [COMMANDS...] end</tt> +\fish{syn} +LOOP_CONSTRUCT; [COMMANDS...] break; [COMMANDS...] end +\endfish + \subsection break-description Description -\c break halts a currently running loop, such as a <a href="#for">for</a> loop or a <a href="#while">while</a> loop. It is usually added inside of a conditional block such as an <a href="#if">if</a> statement or a <a href="#switch">switch</a> statement. +`break` halts a currently running loop, such as a <a href="#for">for</a> loop or a <a href="#while">while</a> loop. It is usually added inside of a conditional block such as an <a href="#if">if</a> statement or a <a href="#switch">switch</a> statement. -There are no parameters for <code>break</code>. +There are no parameters for `break`. \subsection break-example Example The following code searches all .c files for "smurf", and halts at the first occurrence. -<pre> +\fish for i in *.c if grep smurf $i echo Smurfs are present in $i break end end -</pre> +\endfish |