methodsynopsis

methodsynopsis — A syntax summary for a method.

Synopsis

methodsynopsis ::=

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 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.

Children

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

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