summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2008-09-23 14:27:19 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2008-09-23 14:27:19 (GMT)
commit248065d3dd60aa512d6ec1ab9b4229b05af916b0 (patch)
treee8dc01cef65d2035ace15a0b9f8d37d9b10cb8cb
parent93cc89e95b9f7beacfffdc354a2096d7dcb96bd5 (diff)
downloadtcl-248065d3dd60aa512d6ec1ab9b4229b05af916b0.zip
tcl-248065d3dd60aa512d6ec1ab9b4229b05af916b0.tar.gz
tcl-248065d3dd60aa512d6ec1ab9b4229b05af916b0.tar.bz2
Apply [Patch 2082450]
-rw-r--r--ChangeLog2
-rw-r--r--doc/Method.315
2 files changed, 10 insertions, 7 deletions
diff --git a/ChangeLog b/ChangeLog
index 8b5058b..8a6038c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,7 @@
2008-09-23 Donal K. Fellows <dkf@users.sf.net>
+ * doc/Method.3: Corrected documentation. [Patch 2082450]
+
* doc/lreverse.n, mathop.n, regexp.n, regsub.n: Make sure that the
initial line of the manpage includes nothing that chokes old versions
of man. [Bug 2118123]
diff --git a/doc/Method.3 b/doc/Method.3
index a3a1af1..be7bab5 100644
--- a/doc/Method.3
+++ b/doc/Method.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: Method.3,v 1.2 2008/06/29 22:28:24 dkf Exp $
+'\" RCS: @(#) $Id: Method.3,v 1.3 2008/09/23 14:27:25 dkf Exp $
'\"
.so man.macros
.TH Tcl_Method 3 0.1 TclOO "TclOO Library Functions"
@@ -24,9 +24,9 @@ Tcl_Method
\fBTcl_NewInstanceMethod\fR(\fIinterp, object, nameObj, isPublic,
methodTypePtr, clientData\fR)
.sp
-\fBTcl_ClassSetConstructor\fR(\fIclass, method\fR)
+\fBTcl_ClassSetConstructor\fR(\fIinterp, class, method\fR)
.sp
-\fBTcl_ClassSetDestructor\fR(\fIclass, method\fR)
+\fBTcl_ClassSetDestructor\fR(\fIinterp, class, method\fR)
.sp
Tcl_Class
\fBTcl_MethodDeclarerClass\fR(\fImethod\fR)
@@ -113,8 +113,9 @@ assigning the per-method \fIclientData\fR to the variable pointed to by
\fIclientDataPtr\fR if (that is non-NULL) if the type is matched.
.SS "METHOD CREATION"
.PP
-Methods are created by \fBTcl_NewMethod\fR and \fBTcl_NewClassMethod\fR, which
-create a method attached to an object or a class respectively. In both cases,
+Methods are created by \fBTcl_NewMethod\fR and \fBTcl_NewInstanceMethod\fR,
+which
+create a method attached to a class or an object respectively. In both cases,
the \fInameObj\fR argument gives the name of the method to create, the
\fIisPublic\fR argument states whether the method should be exported
initially, the \fImethodTypePtr\fR argument describes the implementation of
@@ -122,7 +123,7 @@ the method (see the \fBMETHOD TYPES\fR section below) and the \fIclientData\fR
argument gives some implementation-specific data that is passed on to the
implementation of the method when it is called.
.PP
-When the \fInameObj\fR argument to \fBTcl_NewClassMethod\fR is NULL, an
+When the \fInameObj\fR argument to \fBTcl_NewMethod\fR is NULL, an
unnamed method is created, which is used for constructors and destructors.
Constructors should be installed into their class using the
\fBTcl_ClassSetConstructor\fR function, and destructors (which must not
@@ -219,7 +220,7 @@ typedef void \fBTcl_MethodDeleteProc\fR(
.PP
The \fIclientData\fR argument to a Tcl_MethodDeleteProc will be the same as
the value passed to the \fIclientData\fR argument to \fBTcl_NewMethod\fR or
-\fBTcl_NewClassMethod\fR when the method was created.
+\fBTcl_NewInstanceMethod\fR when the method was created.
.SS "TCL_CLONEPROC FUNCTION SIGNATURE"
.PP
Functions matching this signature are used to copy a method when the object or