summaryrefslogtreecommitdiffstats
path: root/doc/ParseCmd.3
diff options
context:
space:
mode:
authordgp <dgp@users.sourceforge.net>2003-03-19 20:06:41 (GMT)
committerdgp <dgp@users.sourceforge.net>2003-03-19 20:06:41 (GMT)
commit16a00586d956341e0f805b7fe688c5362bccd40f (patch)
treedf491f0145ca745f6cdc778695fe286df7a04353 /doc/ParseCmd.3
parenta374ad83cefcf100f139968fd2f38021f43d87e3 (diff)
downloadtcl-16a00586d956341e0f805b7fe688c5362bccd40f.zip
tcl-16a00586d956341e0f805b7fe688c5362bccd40f.tar.gz
tcl-16a00586d956341e0f805b7fe688c5362bccd40f.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/ParseCmd.3')
-rw-r--r--doc/ParseCmd.313
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/ParseCmd.3 b/doc/ParseCmd.3
index 0986d8e..ac03337 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.10.2.1 2003/03/19 20:06:50 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;