classsynopsisinfo — Information supplementing the contents of a classsynopsis.


classsynopsisinfo ::=


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

Additional Constraints

  • If this element is the root element, it must have a version attribute.


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.


Common attributes and common linking attributes.


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

Enumerated values:

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


Line numbering restarts (begins at 1, usually).


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


Determines whether lines are numbered.

Enumerated values:

Lines are numbered.


Lines are not numbered.


Specifies the initial line number.


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:

Whitespace must be preserved.


These elements contain classsynopsisinfo: classsynopsis.


The following elements occur in classsynopsisinfo: text, abbrev, accel, acronym, alt, anchor, annotation, application, author, biblioref, buildtarget, citation, citebiblioid, citerefentry, citetitle, classname, co, code, command, computeroutput, constant, coref, database, date, editor, email, emphasis (db._emphasis), emphasis (db.emphasis), enumidentifier, enumname, enumvalue, 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 (, initializer, inlineequation, inlinemediaobject, interfacename, jobtitle, keycap, keycode, keycombo, keysym, lineannotation, link, literal, macroname, 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, revnumber, shortcut, subscript, superscript, symbol, systemitem, tag, templatename, termdef, textobject, token, trademark, type, typedefname, unionname, uri, userinput, varname, wordasword, xref.