O'Reilly logo

DocBook 5: The Definitive Guide by Richard L. Hamilton, Norman Walsh

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Name

constructorsynopsis — A syntax summary for a constructor

Synopsis

constructorsynopsis ::= (modifier*, methodname?, (methodparam+ | void?), exceptionname*)

Attribute synopsis

Common attributes and common linking attributes.

Additional attributes:

  • language

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

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required