summaryrefslogtreecommitdiffstats
path: root/doc/return.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2008-10-17 10:22:24 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2008-10-17 10:22:24 (GMT)
commit842e3ff91428c72a2ce0d4df4889778af82f4b12 (patch)
tree5a94240e321022019f593f6bd712833ab12138c6 /doc/return.n
parent8b464633a0f2df93912ad25af65a5724cd643da2 (diff)
downloadtcl-842e3ff91428c72a2ce0d4df4889778af82f4b12.zip
tcl-842e3ff91428c72a2ce0d4df4889778af82f4b12.tar.gz
tcl-842e3ff91428c72a2ce0d4df4889778af82f4b12.tar.bz2
Improve clarity of formatting.
Diffstat (limited to 'doc/return.n')
-rw-r--r--doc/return.n11
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/return.n b/doc/return.n
index 7432491..5630206 100644
--- a/doc/return.n
+++ b/doc/return.n
@@ -6,7 +6,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: return.n,v 1.20 2008/06/29 22:28:24 dkf Exp $
+'\" RCS: @(#) $Id: return.n,v 1.21 2008/10/17 10:22:25 dkf Exp $
'\"
.so man.macros
.TH return n 8.5 Tcl "Tcl Built-In Commands"
@@ -211,6 +211,7 @@ to be \fBTCL_RETURN\fR, triggering a return from the enclosing procedure.
.PP
First, a simple example of using \fBreturn\fR to return from a
procedure, interrupting the procedure body.
+.PP
.CS
proc printOneLine {} {
puts "line 1" ;# This line will be printed.
@@ -221,6 +222,7 @@ proc printOneLine {} {
.PP
Next, an example of using \fBreturn\fR to set the value
returned by the procedure.
+.PP
.CS
proc returnX {} {\fBreturn\fR X}
puts [returnX] ;# prints "X"
@@ -228,6 +230,7 @@ puts [returnX] ;# prints "X"
.PP
Next, a more complete example, using \fBreturn -code error\fR
to report invalid arguments.
+.PP
.CS
proc factorial {n} {
if {![string is integer $n] || ($n < 0)} {
@@ -253,6 +256,7 @@ proc factorial {n} {
.CE
.PP
Next, a procedure replacement for \fBbreak\fR.
+.PP
.CS
proc myBreak {} {
\fBreturn\fR -code break
@@ -260,13 +264,15 @@ proc myBreak {} {
.CE
.PP
With the \fB\-level 0\fR option, \fBreturn\fR itself can serve
-as a replacement for \fBbreak\fR.
+as a replacement for \fBbreak\fR, with the help of \fBinterp alias\fR.
+.PP
.CS
interp alias {} Break {} \fBreturn\fR -level 0 -code break
.CE
.PP
An example of using \fBcatch\fR and \fBreturn -options\fR to
re-raise a caught error:
+.PP
.CS
proc doSomething {} {
set resource [allocate]
@@ -281,6 +287,7 @@ proc doSomething {} {
.PP
Finally an example of advanced use of the \fBreturn\fR options
to create a procedure replacement for \fBreturn\fR itself:
+.PP
.CS
proc myReturn {args} {
set result ""