V5.2macrosynopsis

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

Synopsis

Parents
×

macrosynopsis ::=

Attributes

Common attributes and common linking attributes.

Additional 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 attributes and common linking attributes.

any attribute

Any attribute in any other explicit namespace

language

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

packageref

Identifies the package to which this synopsis (logically) belongs

Parents

78 elements contain macrosynopsis. × ⏵

These elements contain macrosynopsis: abstract, acknowledgements, annotation, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption (db.caption), caution, chapter, colophon, constraintdef, cover, danger, dedication, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, listitem, meta (db.meta.content), msgexplan, msgtext, note, orderedlist, packagesynopsis, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, result, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, topic, variablelist, warning.

Children

6 elements occur in macrosynopsis. × ⏵

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