diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2018-11-06 11:13:46 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2018-11-06 11:13:46 (GMT) |
| commit | cef37407790d2a84a29438ecec55bfa58032a812 (patch) | |
| tree | c1070a9d838de6ae0419bd60f3ea0d9011a907f9 /doc | |
| parent | 4d25d5aefd2eafbd417ed637e7648a78c2d4d365 (diff) | |
| parent | 37c458acb73d94fa74e19dd036a751a54b5756e1 (diff) | |
| download | tcl-cef37407790d2a84a29438ecec55bfa58032a812.zip tcl-cef37407790d2a84a29438ecec55bfa58032a812.tar.gz tcl-cef37407790d2a84a29438ecec55bfa58032a812.tar.bz2 | |
Implement TIP 519
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/define.n | 23 |
1 files changed, 17 insertions, 6 deletions
diff --git a/doc/define.n b/doc/define.n index 883d5fa..8cab8d3 100644 --- a/doc/define.n +++ b/doc/define.n @@ -140,7 +140,7 @@ where the current namespace is the instance namespace of the class object itself. This is useful for setting up, e.g., class-scoped variables. .VE TIP478 .TP -\fBmethod\fI name argList bodyScript\fR +\fBmethod\fI name \fR?\fIoption\fR? \fIargList bodyScript\fR . This creates or updates a method that is implemented as a procedure-like script. The name of the method is \fIname\fR, the formal arguments to the @@ -150,12 +150,17 @@ the body of the method is evaluated, the current namespace of the method will be a namespace that is unique to the current object. The method will be exported if \fIname\fR starts with a lower-case letter, and non-exported otherwise; this behavior can be overridden via \fBexport\fR and -\fBunexport\fR. +\fBunexport\fR +.VS TIP519 +or by specifying \fB\-export\fR, \fB\-private\fR or \fB\-unexport\fR in the +optional parameter \fIoption\fR. +.VE TIP519 .RS .PP .VS TIP500 If in a private definition context (see the \fBprivate\fR definition command, -below), this command creates private procedure-like methods. +below) or if the \fB\-private\fR flag is given for \fIoption\fR, this command +creates private procedure-like methods. .VE TIP500 .RE .TP @@ -321,7 +326,7 @@ below), this command creates private forwarded methods. .VE TIP500 .RE .TP -\fBmethod\fI name argList bodyScript\fR +\fBmethod\fI name \fR?\fIoption\fR? \fIargList bodyScript\fR . This creates, updates or deletes an object method. The name of the method is \fIname\fR, the formal arguments to the method (defined using the same format @@ -329,12 +334,18 @@ as for the Tcl \fBproc\fR command) will be \fIargList\fR, and the body of the method will be \fIbodyScript\fR. When the body of the method is evaluated, the current namespace of the method will be a namespace that is unique to the object. The method will be exported if \fIname\fR starts with a lower-case -letter, and non-exported otherwise. +letter, and non-exported otherwise; +.VS TIP519 +this can be overridden by specifying \fB\-export\fR, \fB\-private\fR or +\fB\-unexport\fR in the optional parameter \fIoption\fR, or via the +\fBexport\fR and \fBunexport\fR definitions. +.VE TIP519 .RS .PP .VS TIP500 If in a private definition context (see the \fBprivate\fR definition command, -below), this command creates private procedure-like methods. +below) or if the \fB\-private\fR flag is given for \fIoption\fR, this command +creates private procedure-like methods. .VE TIP500 .RE .TP |