classsynopsisinfo
classsynopsisinfo — Information supplementing the contents of a classsynopsis.
Synopsis
classsynopsisinfo ::= ![[-]](figs/web/nav/down.gif)
![[+]](figs/web/nav/right.gif)
- Sequence of:
info? (db.titleforbidden.info)- One of:
- Zero or more of:
- text
lineannotation- Bibliography inlines
- Computer-output inlines
abbrevacronymaltanchorannotationbibliorefcocodecommandcomputeroutputconstantcorefdateemailemphasis(db._emphasis)envarfilenamefirstterm(db._firstterm)footnotefootnoterefforeignphrase(db._foreignphrase)glossterm(db._glossterm)indexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectlinkliteralmarkupnonterminalolinkoptionoptionalpackageparameterphrase(db._phrase)promptpropertyquote(db._quote)remarkreplaceablesubscriptsuperscriptsymbolsystemitemtagtermdeftokentrademarkuriuserinputwordaswordxref
- 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
abbrevacronymcorefdateemphasis(db.emphasis)firstterm(db._firstterm)firstterm(db.firstterm)footnotefootnoterefforeignphrase(db.foreignphrase)glossterm(db._glossterm)glossterm(db.glossterm)phrase(db.phrase)quote(db.quote)subscriptsuperscriptwordasword
- Technical inlines
- Ubiquitous inlines
abbrevacronymaltanchorannotationbibliorefcorefdateemphasis(db._emphasis)firstterm(db._firstterm)footnotefootnoterefforeignphrase(db._foreignphrase)glossterm(db._glossterm)indexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectlinkolinkphrase(db._phrase)quote(db._quote)remarksubscriptsuperscripttrademarkwordaswordxref
- User-input inlines
abbrevaccelacronymaltanchorannotationbibliorefcocodecommandcomputeroutputconstantcorefdateemailemphasis(db._emphasis)envarfilenamefirstterm(db._firstterm)footnotefootnoterefforeignphrase(db._foreignphrase)glossterm(db._glossterm)guibuttonguiiconguilabelguimenuguimenuitemguisubmenuindexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectkeycapkeycodekeycombokeysymlinkliteralmarkupmenuchoicemousebuttonnonterminalolinkoptionoptionalpackageparameterphrase(db._phrase)promptpropertyquote(db._quote)remarkreplaceableshortcutsubscriptsuperscriptsymbolsystemitemtagtermdeftokentrademarkuriuserinputwordaswordxref
textobject
- Zero or more of:
Attributes
Common attributes and common linking attributes.
Additional attributes:
- All of:
- continuation (enumeration)
- “continues”
- “restarts”
- linenumbering (enumeration)
- “numbered”
- “unnumbered”
- startinglinenumber (integer)
- xml:space (enumeration)
- “preserve”
- language
- continuation (enumeration)
Additional Constraints
- If this element is the root element, it must have a version attribute.
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.
Children
The following elements occur in classsynopsisinfo: text, abbrev, accel, acronym, alt, anchor, annotation, application, author, biblioref, citation, citebiblioid, citerefentry, citetitle, classname, co, code, command, computeroutput, constant, coref, database, date, editor, email, emphasis (db._emphasis), emphasis (db.emphasis), envar, errorcode, errorname, errortext, errortype, exceptionname, filename, firstterm (db._firstterm), firstterm (db.firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), foreignphrase (db.foreignphrase), function, glossterm (db._glossterm), glossterm (db.glossterm), guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), initializer, inlineequation, inlinemediaobject, interfacename, jobtitle, keycap, keycode, keycombo, keysym, lineannotation, link, literal, markup, menuchoice, methodname, modifier, mousebutton, nonterminal, olink, ooclass, ooexception, oointerface, option, optional, org, orgname, package, parameter, person, personname, phrase (db._phrase), phrase (db.phrase), productname, productnumber, prompt, property, quote (db._quote), quote (db.quote), remark, replaceable, returnvalue, shortcut, subscript, superscript, symbol, systemitem, tag, termdef, textobject, token, trademark, type, uri, userinput, varname, wordasword, xref.