Skip to main content
Version: DocBook V4.5

classname

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

Synopsis

Mixed Content Model

classname ::=
(#PCDATA|replaceable|inlinegraphic|inlinemediaobject|indexterm|
beginpage)*

Attributes

Common 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.

Children

The following elements occur in classname: beginpage, indexterm, inlinegraphic, inlinemediaobject, replaceable.

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
All user-interface components must be descendants of the
<classname>Widget</classname> class.
</para>

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