DocBook 5.1: The Definitive Guide  (Version 1.5.3 for DocBook 5.1)

classname

classname — The name of a class, in the object-oriented programming sense.

Synopsis

classname ::= [-]

Description

The classname tag is used to identify the name of a class. This is likely to occur only in documentation about object-oriented programming systems, languages, and architectures.

DocBook does not contain a complete set of inlines appropriate for describing object-oriented programming environments. (While it has classname, for example, it has nothing suitable for methods.) This will be addressed in a future version of DocBook.

Processing expectations

Formatted inline.

Children

The following elements occur in classname: text, abbrev, acronym, alt, anchor, annotation, biblioref, coref, date, emphasis (db._emphasis), firstterm (db._firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), glossterm (db._glossterm), indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, phrase (db._phrase), quote (db._quote), remark, replaceable, subscript, superscript, trademark, wordasword, xref.

Examples

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

<para>All user-interface components must be descendants of the
<classname>Widget</classname> class.
</para>

</article>

All user-interface components must be descendants of the Widget class.