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

V5.2typedefsynopsis

typedefsynopsis — The syntax summary for a type-alias definition.

Synopsis

typedefsynopsis ::= [-]

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 typedefsynopsis contains the syntax summary of a type definition (generally speaking, in the programming language sense).

This is one of the few places where DocBook attempts to model as well as describe. The content model of union 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.

Examples

<article xmlns:db="http://docbook.org/ns/docbook"
         xmlns:xlink="http://www.w3.org/1999/xlink"
         version="5.2">
   <info>
      <title>Qt</title>
      <abstract>
         <para>Contains miscellaneous identifiers used throughout the Qt library</para>
      </abstract>
   </info>

   <typedefsynopsis>
     <typedefname>Qt::Alignment</typedefname>
   </typedefsynopsis>
</article>
<typedefsynopsis>
<typedefname>Qt::Alignment</typedefname>
</typedefsynopsis>