methodsynopsis
methodsynopsis — A syntax summary for a method
Synopsis
Content Model
methodsynopsis ::=
(modifier*,
(type|void)?,
methodname,
(methodparam+|void?),
exceptionname*,modifier*)
Attributes
Name | Type | Default |
language | CDATA | None |
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 parenthesis, semicolons, commas, and so on. required in the rendered synopsis.
Parents
These elements contain methodsynopsis: answer, appendix, application, article, attribution, bibliodiv, bibliography, bibliomisc, blockquote, callout, caution, chapter, citation, citetitle, classsynopsis, 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.
Children
The following elements occur in methodsynopsis: exceptionname, methodname, methodparam, modifier, type, void.
Attributes
language
Identifies the programming language of the method.