constructorsynopsis
Prev	DocBook Element Reference	Next

constructorsynopsis

Name

constructorsynopsis — A syntax summary for a constructor

Synopsis

Content Model

constructorsynopsis ::=
(modifier*,methodname?,
 (methodparam+|void),
 exceptionname*)

Attributes

Common attributes

Parameter Entities

The following parameter entities contain constructorsynopsis:

Parameter Entities
`%admon.mix;`	`%bookcomponent.content;`	`%component.mix;`
`%divcomponent.mix;`	`%example.mix;`	`%figure.mix;`
`%footnote.mix;`	`%glossdef.mix;`	`%indexdivcomponent.mix;`
`%method.synop.class;`	`%para.char.mix;`	`%qandaset.mix;`
`%refcomponent.mix;`	`%revdescription.mix;`	`%sidebar.mix;`
`%synop.class;`	`%tbl.entry.mdl;`

Description

A ConstructorSynopsis contains the syntax summary of a constructor in an object-oriented programming language. Unlike a MethodSynopsis, which it closely resembles, it may not identify a return type and the MethodName is optional (in some languages, constructor names can be generated automatically).

Processing expectations

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.

Parents

These elements contain constructorsynopsis: answer, appendix, application, article, attribution, bibliodiv, bibliography, bibliomisc, blockquote, callout, caution, chapter, citation, citetitle, classsynopsis, constraintdef, emphasis, entry, example, figure, footnote, foreignphrase, glossary, glossdef, glossdiv, glosssee, glossseealso, glossterm, important, index, indexdiv, informalexample, informalfigure, lineannotation, link, listitem, literallayout, lotentry, member, msgaud, msgexplan, msgtext, note, olink, para, partintro, phrase, preface, procedure, productname, programlisting, qandadiv, qandaset, question, quote, refentrytitle, refsect1, refsect2, refsect3, refsynopsisdiv, remark, revdescription, screen, screeninfo, sect1, sect2, sect3, sect4, sect5, section, seg, setindex, sidebar, simpara, simplesect, step, synopsis, term, tip, tocback, tocentry, tocfront, ulink, warning.

Children

The following elements occur in constructorsynopsis: exceptionname, methodname, methodparam, modifier, void.

Prev	Home	Next
constraintdef	Up	contractnum