constructorsynopsis

constructorsynopsis — A syntax summary for a constructor.

Synopsis

constructorsynopsis ::=

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • language

Additional Constraints

  • If this element is the root element, it must have a version attribute.

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.

Children

The following elements occur in constructorsynopsis: exceptionname, group (db.group.methodparam), methodname, methodparam, modifier, void.

Last revised by Norman Walsh on 28 Apr 2016 (git hash: 8efbb30ec1f2a59299576c057927c2032216aea4)