Name
methodsynopsis — A syntax summary for a method
Synopsis
methodsynopsis ::=
(modifier*, (type |
void)?, methodname,
(methodparam+ | void),
exceptionname*, modifier*)
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.
- language
Identifies the language (i.e., programming language) of the content
Get DocBook 5: The Definitive Guide now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
