Name
constructorsynopsis — A syntax summary for a constructor
Synopsis
constructorsynopsis ::= (modifier
*,
methodname
?, (methodparam
+ |
void
?), exceptionname
*)
Description
A constructorsynopsis
contains the syntax
summary of a constructor 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, constructor names can 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
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.