$Revision: 1615 $
$Date: 2002-06-10 21:20:20 -0400 (Mon, 10 Jun 2002) $
classsynopsis — The syntax summary for a class definition
classsynopsis ::= ((ooclass
|oointerface
|ooexception
)+, (classsynopsisinfo
|fieldsynopsis
|%method.synop.class;
)*)
Name | Type | Default | |||
language | CDATA | None | |||
class |
| "class" |
The following parameter entities contain classsynopsis:
A ClassSynopsis
contains the syntax summary of a
class (generally speaking, a class in the object-oriented programming
language sense).
This is one of the few places where DocBook attempts to model as well
as describe. Unlike FuncSynopsis
which was designed
with C language function prototypes in mind, the content model of
ClassSynopsis
was designed to capture a wide range
of object-oriented language semantics.
For the most part, the processing application is expected to generate all of the parenthesis, semicolons, commas, and so on. required in the rendered synopsis. The exception to this rule is that the spacing and other punctuation inside a parameter that is a pointer to a function must be provided in the source markup.
These elements contain classsynopsis:
answer
, appendix
, application
, article
, attribution
, bibliodiv
, bibliography
, bibliomisc
, blockquote
, callout
, caution
, chapter
, citation
, citetitle
, constraintdef
, emphasis
, entry
, example
, figure
, firstterm
, footnote
, foreignphrase
, glossary
, glossdef
, glossdiv
, glosssee
, glossseealso
, glossterm
, important
, index
, indexdiv
, informalexample
, informalfigure
, itemizedlist
, lineannotation
, link
, listitem
, literallayout
, lotentry
, member
, msgaud
, msgexplan
, msgtext
, note
, olink
, orderedlist
, para
, partintro
, phrase
, preface
, procedure
, productname
, programlisting
, qandadiv
, qandaset
, question
, quote
, refentrytitle
, refsect1
, refsect2
, refsect3
, refsection
, refsynopsisdiv
, remark
, revdescription
, screen
, screeninfo
, sect1
, sect2
, sect3
, sect4
, sect5
, section
, seg
, setindex
, sidebar
, simpara
, simplesect
, step
, synopsis
, taskprerequisites
, taskrelated
, tasksummary
, td
, term
, termdef
, th
, tip
, tocback
, tocentry
, tocfront
, ulink
, variablelist
, warning
.
The following elements occur in classsynopsis:
classsynopsisinfo
, constructorsynopsis
, destructorsynopsis
, fieldsynopsis
, methodsynopsis
, ooclass
, ooexception
, oointerface
.