classsynopsisinfo
classsynopsisinfo — Information supplementing the contents of a ClassSynopsis.
Synopsis
- Sequence of:
info
? (db.titleforbidden.info)- One of:
- Zero or more of:
- text
lineannotation
- Bibliography inlines
- Computer-output inlines
alt
anchor
annotation
biblioref
co
code
command
computeroutput
constant
email
envar
filename
indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)inlinemediaobject
link
literal
markup
nonterminal
olink
option
optional
package
parameter
prompt
property
remark
replaceable
subscript
superscript
symbol
systemitem
tag
termdef
token
uri
userinput
xref
- Error inlines
- Graphic inlines
- GUI inlines
- Indexing inlines
- Keyboard inlines
- Linking inlines
- Markup inlines
- Math inlines
- Object-oriented programming inlines
- Operating system inlines
- Product inlines
- Programming inlines
- Publishing inlines
- Technical inlines
- 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
- User-input inlines
accel
alt
anchor
annotation
biblioref
co
code
command
computeroutput
constant
email
envar
filename
guibutton
guiicon
guilabel
guimenu
guimenuitem
guisubmenu
indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)inlinemediaobject
keycap
keycode
keycombo
keysym
link
literal
markup
menuchoice
mousebutton
nonterminal
olink
option
optional
package
parameter
prompt
property
remark
replaceable
shortcut
subscript
superscript
symbol
systemitem
tag
termdef
token
uri
userinput
xref
textobject
- Zero or more of:
Attributes
Common attributes and common linking attributes.
Additional attributes:
- 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 line breaks 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
.