classname

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

Synopsis

classname ::=

Zero or more of:
- text
- phrase (db._phrase)
- replaceable
- Graphic inlines
  inlinemediaobject
- Indexing inlines
  indexterm (db.indexterm.endofrange)
  
  indexterm (db.indexterm.singular)
  
  indexterm (db.indexterm.startofrange)
- Linking inlines
  anchor
  
  biblioref
  
  link
  
  olink
  
  xref
- Ubiquitous inlines
  alt
  
  anchor
  
  annotation
  
  biblioref
  
  indexterm (db.indexterm.endofrange)
  
  indexterm (db.indexterm.singular)
  
  indexterm (db.indexterm.startofrange)
  
  inlinemediaobject
  
  link
  
  olink
  
  remark
  
  subscript
  
  superscript
  
  xref

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: bridgehead, caption (db.html.caption), citation, citetitle, classsynopsisinfo, code, emphasis (db.emphasis), entry, firstterm, funcsynopsisinfo, glosssee, glossseealso, glossterm, html:button, html:label, html:legend, link, literallayout, member, olink, ooclass, orgdiv, para, phrase (db.phrase), primary, primaryie, programlisting, quote, refdescriptor, refentrytitle, refname, refpurpose, screen, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocentry.

Children

The following elements occur in classname: text, alt, anchor, annotation, biblioref, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, phrase (db._phrase), remark, replaceable, subscript, superscript, 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.

ChangeLog

This alpha reference page is $Revision: 7120 $ published Sun, 22 Jul 2007.


city		classsynopsis