diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2004-10-27 09:35:37 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2004-10-27 09:35:37 (GMT) |
| commit | 7ea5d4dbe8b82a86701cec95132a8a9557a5f105 (patch) | |
| tree | 2f3f979845a50074bb8e2a0687cd98cb14ae6c26 /doc/break.n | |
| parent | a50314f88b2a6af554553927c9c0e590c0acf7dc (diff) | |
| download | tcl-7ea5d4dbe8b82a86701cec95132a8a9557a5f105.zip tcl-7ea5d4dbe8b82a86701cec95132a8a9557a5f105.tar.gz tcl-7ea5d4dbe8b82a86701cec95132a8a9557a5f105.tar.bz2 | |
Backport many doc fixes
Diffstat (limited to 'doc/break.n')
| -rw-r--r-- | doc/break.n | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/doc/break.n b/doc/break.n index 32432eb..7f7462e 100644 --- a/doc/break.n +++ b/doc/break.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: break.n,v 1.3 2000/09/07 14:27:46 poenitz Exp $ +'\" RCS: @(#) $Id: break.n,v 1.3.18.1 2004/10/27 09:35:38 dkf Exp $ '\" .so man.macros .TH break n "" Tcl "Tcl Built-In Commands" @@ -21,7 +21,7 @@ break \- Abort looping command .PP This command is typically invoked inside the body of a looping command such as \fBfor\fR or \fBforeach\fR or \fBwhile\fR. -It returns a TCL_BREAK code, which causes a break exception +It returns a \fBTCL_BREAK\fR code, which causes a break exception to occur. The exception causes the current script to be aborted out to the innermost containing loop command, which then @@ -29,9 +29,19 @@ aborts its execution and returns normally. Break exceptions are also handled in a few other situations, such as the \fBcatch\fR command, Tk event bindings, and the outermost scripts of procedure bodies. +.SH EXAMPLE +Print a line for each of the integers from 0 to 5: +.CS +for {set x 0} {$x<10} {incr x} { + if {$x > 5} { + \fBbreak\fR + } + puts "x is $x" +} +.CE .SH "SEE ALSO" -catch(n), continue(n), for(n), foreach(n), while(n) +catch(n), continue(n), for(n), foreach(n), return(n), while(n) .SH KEYWORDS abort, break, loop |