destructorsynopsis
destructorsynopsis — A syntax summary for a destructor.
Synopsis
destructorsynopsis ::=
- Sequence of:
- Zero or more of:
methodname?- One of:
- One or more of:
group(db.group.methodparam)methodparam
void?
- One or more of:
- Zero or more of:
Attributes
Additional Constraints
- If this element is the root element, it must have a version attribute.
Description
A destructorsynopsis contains the syntax
summary of a destructor 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, destructors have an immutable name which
may be generated automatically).
Processing expectations
For the most part, the processing application is expected to generate all of the parentheses, semicolons, commas, and so on required in the rendered synopsis.
Attributes
Common attributes and common linking attributes.
- language
Identifies the language (i.e. programming language) of the content.
Parents
These elements contain destructorsynopsis: acknowledgements, annotation, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption (db.caption), caution, chapter, classsynopsis, colophon, constraintdef, cover, dedication, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, listitem, msgexplan, msgtext, note, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, result, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, topic, variablelist, warning.
Children
The following elements occur in destructorsynopsis: exceptionname, group (db.group.methodparam), methodname, methodparam, modifier, void.