classsynopsisinfo

classsynopsisinfo — Information supplementing the contents of a ClassSynopsis

Synopsis

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • All of:
    • continuation (enumeration)
      • “continues”
      • “restarts”
    • linenumbering (enumeration)
      • “numbered”
      • “unnumbered”
    • startinglinenumber (integer)
    • language
    • xml:space (enumeration)
      • “preserve”

Description

Supplementary information in a classsynopsis. See classsynopsis.

Unlike the other info elements, classsynopsisinfo is not a container for meta-information. Instead classsynopsisinfo is a verbatim environment for adding additional information to a class synopsis.

Processing expectations

This element is displayed “verbatim”; whitespace and linebreaks within this element are significant.

Attributes

Common attributes and common linking attributes.

continuation

Determines whether line numbering continues from the previous element or restarts.

Enumerated values:

continues

Line numbering continues from the immediately preceding element with the same name.

restarts

Line numbering restarts (begins at 1, usually).

language

Identifies the language (i.e. programming language) of the verbatim content.

linenumbering

Determines whether lines are numbered.

Enumerated values:

numbered

Lines are numbered.

unnumbered

Lines are not numbered.

startinglinenumber

Specifies the initial line number.

xml:space

Can be used to indicate explicitly that whitespace in the verbatim environment is preserved. Whitespace must always be preserved in verbatim environments whether this attribute is specified or not.

Enumerated values:

preserve

Whitespace must be preserved.

Parents

These elements contain classsynopsisinfo: classsynopsis.

ChangeLog

This alpha reference page is $Revision: 1.3 $ published $Date: 2005/07/07 16:40:30 $.