commit 13d9da2ae0317b9c58205eb5de842684b36d0386
parent d29d7ef3b04bf3a1db7814f5a0e58e8e75341cb0
Author: Matthew Flatt <mflatt@racket-lang.org>
Date: Tue, 12 Feb 2008 15:16:03 +0000
more browser doc repairs
svn: r8634
original commit: 074b611215653705571ab5179aa8c4f4d2350b2e
Diffstat:
1 file changed, 14 insertions(+), 5 deletions(-)
diff --git a/collects/scribblings/scribble/manual.scrbl b/collects/scribblings/scribble/manual.scrbl
@@ -513,12 +513,15 @@ at once, aligned around the @litchar{=} and @litchar{|}.}
@; ------------------------------------------------------------------------
@section[#:tag "doc-classes"]{Documenting Classes and Interfaces}
-@defform[(defclass id super-id (intf-id ...) pre-flow ...)]{
+@defform/subs[(defclass id super (intf-id ...) pre-flow ...)
+ ([super super-id
+ (mixin-id super)])]{
Creates documentation for a class @scheme[id] that is a subclass of
-@scheme[super-id] and implements each interface @scheme[intf-id]. Each
-@scheme[super-id] (except @scheme[object%]) and @scheme[intf-id] must
-be documented somewhere via @scheme[defclass] or @scheme[definterface].
+@scheme[super] and implements each interface @scheme[intf-id]. Each
+identifier in @scheme[super] (except @scheme[object%]) and
+@scheme[intf-id] must be documented somewhere via @scheme[defclass] or
+@scheme[definterface].
The decoding of the @scheme[pre-flow] sequence should start with
general documentation about the class, followed by constructor
@@ -527,7 +530,7 @@ definitions (see @scheme[defmethod]). In rendered form, the
constructor and method specification are indented to visually group
them under the class definition.}
-@defform[(defclass/title id super-id (intf-id ...) pre-flow ...)]{
+@defform[(defclass/title id super (intf-id ...) pre-flow ...)]{
Like @scheme[defclass], also includes a @scheme[title] declaration
with the style @scheme['hidden]. In addition, the constructor and
@@ -580,6 +583,12 @@ of by-name arguments (for use with @scheme[new]).}
Like @scheme[defconstructor/make], but with multiple constructor
patterns analogous @scheme[defproc*].}
+@defform[(defconstructor/super-init [(arg-spec ...) ...] pre-flow ...)]{
+
+Like @scheme[defconstructor/super-init], but the constructor is
+annotated to indicate that additional initialization arguments are
+accepted and propagated to the sueprclass.}
+
@defform[(defmethod (id arg-spec ...)
result-contract-expr-datum
pre-flow ...)]{