DocBook 5: The Definitive Guide

Name

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

Synopsis

classname ::= (text | phrase ^db._phrase | replaceable | Graphic inlines | Indexing inlines | Linking inlines | Ubiquitous inlines)*

Attribute synopsis

Common attributes and common linking attributes.

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.

See Also

property, symbol, token, type

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.