diff options
Diffstat (limited to 'doc_src/break.txt')
-rw-r--r-- | doc_src/break.txt | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc_src/break.txt b/doc_src/break.txt new file mode 100644 index 00000000..03e8a416 --- /dev/null +++ b/doc_src/break.txt @@ -0,0 +1,21 @@ + +\section break break - stop the innermost currently evaluated loop + +\subsection break-synopsis Synopsis + <tt>LOOP_CONSTRUCT; [COMMANDS...] break; [COMMANDS...] end</tt> + +\subsection break-description Description +The \c break builtin is used to halt 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. + +\subsection break-example Example +The following code searches all .c files for smurfs, and halts at the first occurance. +<p> +<tt>for i in *.c; +<br> if grep smurf $i; +<br> echo Smurfs are present in $i; +<br> break; +<br> end; +<br>end; +</tt> +</p> + |