[4.0]classsynopsisinfo

$Revision$

$Date$

classsynopsisinfo — Information supplementing the contents of a ClassSynopsis

Synopsis

Mixed Content Model

classsynopsisinfo ::=
(#PCDATA|link|olink|ulink|action|application|classname|methodname|
 interfacename|exceptionname|ooclass|oointerface|ooexception|
 package|command|computeroutput|database|email|envar|errorcode|
 errorname|errortype|errortext|filename|function|guibutton|
 guiicon|guilabel|guimenu|guimenuitem|guisubmenu|hardware|
 interface|keycap|keycode|keycombo|keysym|literal|code|constant|
 markup|medialabel|menuchoice|mousebutton|option|optional|
 parameter|prompt|property|replaceable|returnvalue|sgmltag|
 structfield|structname|symbol|systemitem|uri|token|type|
 userinput|varname|nonterminal|anchor|remark|subscript|
 superscript|inlinegraphic|inlinemediaobject|indexterm|beginpage|
 textobject|lineannotation)*

Attributes

Common attributes

Name

Type

Default

linenumbering
Enumeration:
numbered
unnumbered
None
language CDATA None
xml:space
Enumeration:
preserve
None
continuation
Enumeration:
continues
restarts
None
format
Enumerated notation:
linespecific
"linespecific"
startinglinenumber CDATA None

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.

Parents

These elements contain classsynopsisinfo: classsynopsis.

Attributes

format

[4.0] The Format attribute applies the linespecific notation to all ClassSynopsisInfos. All white space and line breaks must be preserved.

linenumbering

[4.0]Line numbering indicates whether or not the lines of a ClassSynopsisInfo are to be automatically numbered. The details of numbering (every line or only selected lines, on the left or right, etc.) are left up to the processing application. Be aware that not all processors are capable of numbering lines.