summaryrefslogtreecommitdiffstats
path: root/doc/ParseArgs.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2012-11-08 15:21:29 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2012-11-08 15:21:29 (GMT)
commit58bc28f4d96ce554e59258f7386e128da4e41022 (patch)
treed58085c9ab939943ea31fedc202f83ff7bcff0b0 /doc/ParseArgs.3
parent2c8604178c0e8b9dcde646dec80f3552cb4ec37e (diff)
downloadtcl-58bc28f4d96ce554e59258f7386e128da4e41022.zip
tcl-58bc28f4d96ce554e59258f7386e128da4e41022.tar.gz
tcl-58bc28f4d96ce554e59258f7386e128da4e41022.tar.bz2
Updated the language of the documentation so that "object" refers to an OO
concept throughout, and a Tcl_Obj is called a "value" (which is what it is).
Diffstat (limited to 'doc/ParseArgs.3')
-rw-r--r--doc/ParseArgs.34
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/ParseArgs.3 b/doc/ParseArgs.3
index dd33830..1ceafe5 100644
--- a/doc/ParseArgs.3
+++ b/doc/ParseArgs.3
@@ -134,7 +134,7 @@ typedef int (\fBTcl_ArgvFuncProc\fR)(
.PP
The result is a boolean value indicating whether to consume the following
argument. The \fIclientData\fR is the value from the table entry, the
-\fIobjPtr\fR is the object that represents the following argument or NULL if
+\fIobjPtr\fR is the value that represents the following argument or NULL if
there are no following arguments at all, and the \fIdstPtr\fR argument to the
\fBTcl_ArgvFuncProc\fR is the location to write the parsed value to.
.RE
@@ -186,7 +186,7 @@ marks all following arguments to be left unprocessed. The \fIsrcPtr\fR,
.
This argument takes a following string value argument. A pointer to the string
will be stored at \fIdstPtr\fR; the string inside will have a lifetime linked
-to the lifetime of the string representation of the argument object that it
+to the lifetime of the string representation of the argument value that it
came from, and so should be copied if it needs to be retained. The
\fIsrcPtr\fR and \fIclientData\fR fields are ignored.
.SH "SEE ALSO"