summaryrefslogtreecommitdiffstats
path: root/doc/object.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2008-10-17 10:22:24 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2008-10-17 10:22:24 (GMT)
commit842e3ff91428c72a2ce0d4df4889778af82f4b12 (patch)
tree5a94240e321022019f593f6bd712833ab12138c6 /doc/object.n
parent8b464633a0f2df93912ad25af65a5724cd643da2 (diff)
downloadtcl-842e3ff91428c72a2ce0d4df4889778af82f4b12.zip
tcl-842e3ff91428c72a2ce0d4df4889778af82f4b12.tar.gz
tcl-842e3ff91428c72a2ce0d4df4889778af82f4b12.tar.bz2
Improve clarity of formatting.
Diffstat (limited to 'doc/object.n')
-rw-r--r--doc/object.n8
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/object.n b/doc/object.n
index 47acd04..0836728 100644
--- a/doc/object.n
+++ b/doc/object.n
@@ -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: object.n,v 1.3 2008/09/26 20:16:39 dgp Exp $
+'\" RCS: @(#) $Id: object.n,v 1.4 2008/10/17 10:22:25 dkf Exp $
'\"
.so man.macros
.TH object n 0.1 TclOO "TclOO Commands"
@@ -23,8 +23,8 @@ package require TclOO
\fBoo::object\fR
.fi
.BE
-
.SH DESCRIPTION
+.PP
The \fBoo::object\fR class is the root class of the object hierarchy; every
object (and hence every class) is an instance of this class. Objects are
always referred to by their name, and may be \fBrename\fRd while maintaining
@@ -46,6 +46,7 @@ any destructors on the object's class in the process. It is equivalent to
using \fBrename\fR to delete the object command. The result of this method is
always the empty string.
.SS "NON-EXPORTED METHODS"
+.PP
The \fBoo::object\fR class supports the following non-exported methods:
.TP
\fIobj \fBeval\fR ?\fIarg ...\fR?
@@ -76,7 +77,9 @@ must not have any namespace separators in it. The result is the empty string.
This method returns the globally qualified name of the variable \fIvarName\fR
in the unique namespace for the object \fIobj\fR.
.SH EXAMPLES
+.PP
This example demonstrates basic use of an object.
+.PP
.CS
set obj [\fBoo::object\fR new]
$obj foo \fI\(-> error "unknown method foo"\fR
@@ -94,7 +97,6 @@ $obj foo \fI\(-> error "unknown command obj"\fR
my(n), oo::class(n)
.SH KEYWORDS
base class, class, object, root class
-
.\" Local variables:
.\" mode: nroff
.\" fill-column: 78