DocBook 5.2: The Definitive Guide  (Version 5.2.6 for DocBook 5.2b09a)

V5.2macrosynopsis

macrosynopsis — The syntax summary for a macro definition (code-generating function).

Synopsis

macrosynopsis ::= [-]

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 macrosynopsis contains the syntax summary of a programming language macro.

This is one of the few places where DocBook attempts to model as well as describe. The content model of unionsynopsis was designed to capture a wide range of semantics.

Processing expectations

Formatted inline.

Attributes

Common attributes and common linking attributes.

language

Identifies the language (i.e. programming language) of the content.