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

methodsynopsis — A syntax summary for a method

Synopsis

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

Attribute synopsis

Common attributes and common linking attributes.

Additional attributes:

  • language

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

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