V5.2macrosynopsis

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

Synopsis

macrosynopsis ::=

Attributes

Common linking attributes.

Attributes:

  • language
  • packageref

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 macrosynopsis was designed to capture a wide range of semantics.

Processing expectations

Formatted inline.

Attributes

Common linking attributes.

any attribute

Any attribute in an other explicit namespace.

language

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

packageref

Identifies the package to which this synopsis (logically) belongs

Children

The following elements occur in macrosynopsis: info (db.titleforbidden.info), macroname, macroprototype, modifier, package, synopsisinfo.