classname

$Revision: 1.3 $

$Date: 2002/06/12 11:18:04 $

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

DocBook NG “Bourbon” Content Model

classname ::=

Zero or more of:

text
anchor
indexterm (indexterm.endofrange)
indexterm (indexterm.singular)
indexterm (indexterm.startofrange)
inlinemediaobject
phrase (text.phrase)
remark
replaceable

DocBook NG “Bourbon” Attributes

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.

Parents

These elements contain classname: action, application, attribution, bibliomisc, bridgehead, citation, citetitle, classsynopsisinfo, code, command, computeroutput, database, emphasis, entry, filename, firstterm, foreignphrase, funcparams, funcsynopsisinfo, function, glosssee, glossseealso, glossterm, hardware, interfacename, keycap, lineannotation, link, literal, literallayout, lotentry, member, msgaud, olink, ooclass, option, optional, para, parameter, phrase, primary, primaryie, productname, programlisting, property, quote, refdescriptor, refentrytitle, refname, refpurpose, remark, screen, screeninfo, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, systemitem, td, term, tertiary, tertiaryie, th, title, titleabbrev, tocback, tocentry, tocfront, trademark, ulink, userinput.

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.


city		classsynopsis