methodsynopsis
methodsynopsis — A syntax summary for a method.
Synopsis
methodsynopsis ::=
- Sequence of:
info? (db.titleforbidden.info)- Zero or more of:
- Zero or more of:
- Optionally one of:
methodname- Zero or more of:
- One of:
- One or more of:
group(db.group.methodparam)methodparam
void
- One or more of:
- Zero or more of:
- Zero or more of:
Attributes
Common attributes and common linking attributes.
Additional attributes:
- language
- packageref
Additional Constraints
- If this element is the root element, it must have a version attribute.
Description
A methodsynopsis contains the syntax summary of a
method (generally speaking, methods 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
methodsynopsis was designed to capture a wide range of
semantics.
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.
- any attribute
Any attribute in any other explicit namespace
- language
Identifies the language (i.e. programming language) of the content
- packageref
Identifies the package to which this synopsis (logically) belongs
Parents
These elements contain methodsynopsis: abstract, acknowledgements, annotation, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption (db.caption), caution, chapter, classsynopsis, colophon, constraintdef, cover, danger, dedication, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, listitem, meta (db.meta.content), msgexplan, msgtext, note, orderedlist, packagesynopsis, 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 methodsynopsis: exceptionname, group (db.group.methodparam), info (db.titleforbidden.info), methodname, methodparam, modifier, synopsisinfo, templatename, type, void.