    |
DocBook: The Definitive Guide 0.0.25 for DocBook V5.0 (Alpha) |
| |
DocBook: The Definitive Guide 0.0.25 for DocBook V5.0 (Alpha) |
methodsynopsis — A syntax summary for a method
methodsynopsis ::=
methodnamevoidA 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.
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.
Common attributes and common linking attributes.
Identifies the language (i.e. programming language) of the content.
These elements contain methodsynopsis: 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, html:fieldset, html:form, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, listitem, msgexplan, msgtext, note, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, revdescription, sect1, sect2,
sect3, sect4, sect5, section, setindex, sidebar, simplesect,
step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, variablelist, warning.
The following elements occur in methodsynopsis: exceptionname, methodname, methodparam, modifier, type, void.
| |
|
|
| methodparam | |
modifier |