suzanne.soy/hyper-literate
1
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

more browser doc repairs

Browse Source 
svn: r8634

original commit: 074b611215653705571ab5179aa8c4f4d2350b2e
This commit is contained in:
Matthew Flatt 2008-02-12 15:16:03 +00:00
parent d29d7ef3b0
commit 13d9da2ae0
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
collects/scribblings/scribble/manual.scrbl
View File

@ -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 ...)]{