V5.2typedefsynopsis
typedefsynopsis — The syntax summary for a type-alias definition.
Synopsis
typedefsynopsis ::= ![[-]](figs/web/nav/down.gif)
![[+]](figs/web/nav/right.gif)
- Sequence of:
typedefname- Zero or more of:
- Object-oriented programming inlines
- Programming inlines
- Object-oriented programming inlines
- Optionally one of:
- Sequence of:
- One or more of:
annotationbridgeheadformalgroupremarkrevhistory- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
informalequationinformalexampleinformalfigureinformaltable(db.cals.informaltable)informaltable(db.html.informaltable)
- List elements
- Paragraph elements
- Publishing elements
- Synopsis elements
- Technical elements
- Verbatim elements
- Optionally one of:
- Sequence of:
- One or more of:
- Zero or more of:
- One or more of:
- One or more of:
- Sequence of:
- One or more of:
- Sequence of:
- One or more of:
- Zero or more of:
- One or more of:
- One or more of:
- Sequence of:
Attributes
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.
Parents
These elements contain typedefsynopsis: abstract, acknowledgements, annotation, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption (db.caption), caution, chapter, classsynopsis, colophon, constraintdef, cover, danger, dedication, entry, enumsynopsis, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, legalsection, listitem, macrosynopsis, methodparam, methodsynopsis, msgexplan, msgtext, namespacesynopsis, note, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, result, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, synopsisinfo, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, topic, typedefsynopsis, unionsynopsis, variablelist, warning.
Children
The following elements occur in typedefsynopsis: address, anchor, annotation, bibliolist, blockquote, bridgehead, buildtarget, calloutlist, caution, classname, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, danger, destructorsynopsis, enumidentifier, enumname, enumsynopsis, enumvalue, epigraph, equation, example, exceptionname, fieldsynopsis, figure, formalgroup, formalpara, funcsynopsis, function, glosslist, important, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), informalequation, informalexample, informalfigure, informaltable (db.cals.informaltable), informaltable (db.html.informaltable), initializer, interfacename, itemizedlist, legalsection, literallayout, macroname, macrosynopsis, mediaobject, methodname, methodsynopsis, modifier, msgset, namespace, namespacename, namespacesynopsis, note, ooclass, ooexception, oointerface, orderedlist, para, parameter, procedure, productionset, programlisting, programlistingco, qandaset, refentry, remark, returnvalue, revhistory, screen, screenco, screenshot, section, segmentedlist, sidebar, simpara, simplelist, simplesect, synopsis, table (db.cals.table), table (db.html.table), task, templateid, tip, type, typedefname, typedefsynopsis, unionname, unionsynopsis, variablelist, varname, warning.
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>