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

type

type — The classification of a value.

Synopsis

type ::= [-]

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • class (enumeration)
    • “union”
    • “intersection”

Description

In general usage, type identifies one member of a class of values.

In documenting computer programs, it identifies specifically a “type,” as might be declared with typedef in the C programming language.

Processing expectations

Formatted inline.

Attributes

Common attributes and common linking attributes.

class

Specifies the way how are nested types combined together

Enumerated values:
“union”

Combined type is union of nested types

“intersection”

Combined type is intersection of nested types

Children

The following elements occur in type: text, abbrev, acronym, alt, anchor, annotation, biblioref, buildtarget, classname, coref, date, emphasis (db._emphasis), enumidentifier, enumname, enumvalue, exceptionname, firstterm (db._firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), function, glossterm (db._glossterm), indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), initializer, inlinemediaobject, interfacename, link, macroname, methodname, modifier, namespace, namespacename, olink, ooclass, ooexception, oointerface, parameter, phrase (db._phrase), quote (db._quote), remark, replaceable, returnvalue, subscript, superscript, templateid, trademark, type, typedefname, unionname, varname, wordasword, xref.

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example type</title>

<para>The <function>geteuid</function> function returns a <type>uid_t</type> that
contains the user's <emphasis>effective</emphasis> user id.
</para>

</article>

The geteuid function returns a uid_t that contains the user's effective user id.