summaryrefslogtreecommitdiffstats
path: root/generic/tclExecute.c
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2015-08-03 07:18:13 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2015-08-03 07:18:13 (GMT)
commit93f508a5da2f4e6bc476514652410ce734a97537 (patch)
tree108bcc3c44075bc53eb563f26b7a5461b5a4167d /generic/tclExecute.c
parente9e00655085d4adea3b0d81b30827c598cb4dcc1 (diff)
downloadtcl-93f508a5da2f4e6bc476514652410ce734a97537.zip
tcl-93f508a5da2f4e6bc476514652410ce734a97537.tar.gz
tcl-93f508a5da2f4e6bc476514652410ce734a97537.tar.bz2
Fix the documentation comment.Coverity_CID_1251203
Diffstat (limited to 'generic/tclExecute.c')
-rw-r--r--generic/tclExecute.c15
1 files changed, 8 insertions, 7 deletions
diff --git a/generic/tclExecute.c b/generic/tclExecute.c
index 2fa0928..8ada6d2 100644
--- a/generic/tclExecute.c
+++ b/generic/tclExecute.c
@@ -10112,13 +10112,14 @@ GetSrcInfoForPc(
* ExceptionRange.
*
* Results:
- * In the normal case, catchOnly is 0 (false) and this procedure returns
- * a pointer to the most closely enclosing ExceptionRange structure
- * regardless of whether it is a loop or catch exception range. This is
- * appropriate when processing a TCL_BREAK or TCL_CONTINUE, which will be
- * "handled" either by a loop exception range or a closer catch range. If
- * catchOnly is nonzero, this procedure ignores loop exception ranges and
- * returns a pointer to the closest catch range. If no matching
+ * If the searchMode is TCL_ERROR, this procedure ignores loop exception
+ * ranges and returns a pointer to the closest catch range. If the
+ * searchMode is TCL_BREAK, this procedure returns a pointer to the most
+ * closely enclosing ExceptionRange regardless of whether it is a loop or
+ * catch exception range. If the searchMode is TCL_CONTINUE, this
+ * procedure returns a pointer to the most closely enclosing
+ * ExceptionRange (of any type) skipping only loop exception ranges if
+ * they don't have a sensible continueOffset defined. If no matching
* ExceptionRange is found that encloses pc, a NULL is returned.
*
* Side effects: