summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authordgp <dgp@users.sourceforge.net>2003-03-19 20:07:12 (GMT)
committerdgp <dgp@users.sourceforge.net>2003-03-19 20:07:12 (GMT)
commit2f7a25d9e6cc43c401cbb12b0a35adca9ba526ca (patch)
tree3addbdb32429e38c6ee8c951201671d556977ae5 /doc
parentd9155272bb564f8042c5e7ff324807a01c31bc83 (diff)
downloadtcl-2f7a25d9e6cc43c401cbb12b0a35adca9ba526ca.zip
tcl-2f7a25d9e6cc43c401cbb12b0a35adca9ba526ca.tar.gz
tcl-2f7a25d9e6cc43c401cbb12b0a35adca9ba526ca.tar.bz2
* doc/Eval.3 (Tcl_EvalObjEx): Corrected CONST and
* doc/ParseCmd.3 (Tcl_EvalTokensStandard): return type errors in documentation. [Bug 683994]
Diffstat (limited to 'doc')
-rw-r--r--doc/Eval.35
-rw-r--r--doc/ParseCmd.313
2 files changed, 10 insertions, 8 deletions
diff --git a/doc/Eval.3 b/doc/Eval.3
index 4b9ecac..95f9d69 100644
--- a/doc/Eval.3
+++ b/doc/Eval.3
@@ -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: Eval.3,v 1.12 2002/08/05 03:24:39 dgp Exp $
+'\" RCS: @(#) $Id: Eval.3,v 1.13 2003/03/19 20:07:16 dgp Exp $
'\"
.so man.macros
.TH Tcl_Eval 3 8.1 Tcl "Tcl Library Procedures"
@@ -91,7 +91,8 @@ can be skipped if the object is evaluated again in the future.
The return value from \fBTcl_EvalObjEx\fR (and all the other procedures
described here) is a Tcl completion code with
one of the values \fBTCL_OK\fR, \fBTCL_ERROR\fR, \fBTCL_RETURN\fR,
-\fBTCL_BREAK\fR, or \fBTCL_CONTINUE\fR.
+\fBTCL_BREAK\fR, or \fBTCL_CONTINUE\fR, or possibly some other
+integer value originating in an extension.
In addition, a result value or error message is left in \fIinterp\fR's
result; it can be retrieved using \fBTcl_GetObjResult\fR.
.PP
diff --git a/doc/ParseCmd.3 b/doc/ParseCmd.3
index 0986d8e..34826d9 100644
--- a/doc/ParseCmd.3
+++ b/doc/ParseCmd.3
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: ParseCmd.3,v 1.10 2002/08/05 03:24:39 dgp Exp $
+'\" RCS: @(#) $Id: ParseCmd.3,v 1.11 2003/03/19 20:07:17 dgp Exp $
'\"
.so man.macros
.TH Tcl_ParseCommand 3 8.3 Tcl "Tcl Library Procedures"
@@ -38,7 +38,7 @@ CONST char *
Tcl_Obj *
\fBTcl_EvalTokens\fR(\fIinterp, tokenPtr, numTokens\fR)
.sp
-Tcl_Obj *
+int
\fBTcl_EvalTokensStandard\fR(\fIinterp, tokenPtr, numTokens\fR)
.SH ARGUMENTS
.AS Tcl_Interp *usedParsePtr
@@ -190,7 +190,8 @@ substitutions requested by the tokens and concatenates the
resulting values.
The return value from \fBTcl_EvalTokensStandard\fR is a Tcl completion
code with one of the values \fBTCL_OK\fR, \fBTCL_ERROR\fR,
-\fBTCL_RETURN\fR, \fBTCL_BREAK\fR, or \fBTCL_CONTINUE\fR.
+\fBTCL_RETURN\fR, \fBTCL_BREAK\fR, or \fBTCL_CONTINUE\fR, or possibly
+some other integer value originating in an extension.
In addition, a result value or error message is left in \fIinterp\fR's
result; it can be retrieved using \fBTcl_GetObjResult\fR.
.PP
@@ -211,9 +212,9 @@ of \fBTcl_EvalTokens\fR is deprecated.
return parse information in two data structures, Tcl_Parse and Tcl_Token:
.CS
typedef struct Tcl_Parse {
- char *\fIcommentStart\fR;
+ CONST char *\fIcommentStart\fR;
int \fIcommentSize\fR;
- char *\fIcommandStart\fR;
+ CONST char *\fIcommandStart\fR;
int \fIcommandSize\fR;
int \fInumWords\fR;
Tcl_Token *\fItokenPtr\fR;
@@ -223,7 +224,7 @@ typedef struct Tcl_Parse {
typedef struct Tcl_Token {
int \fItype\fR;
- char *\fIstart\fR;
+ CONST char *\fIstart\fR;
int \fIsize\fR;
int \fInumComponents\fR;
} Tcl_Token;