funcsynopsisinfo

funcsynopsisinfo — Information supplementing the funcdefs of a funcsynopsis.

Synopsis

funcsynopsisinfo ::=

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

Additional Constraints

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

Description

Supplementary information in a funcsynopsis. See funcsynopsis.

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

Processing expectations

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

Attributes

Common attributes and common linking attributes.

any attribute

Any attribute in any other explicit namespace

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 funcsynopsisinfo: funcsynopsis.

Children

The following elements occur in funcsynopsisinfo: 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 (db.titleforbidden.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.

See Also

Related elements: funcdef, funcparams, funcprototype, function, paramdef, parameter, returnvalue, varargs, void.

Examples

 1 |<article xmlns='http://docbook.org/ns/docbook'>
   |<title>Example funcsynopsis</title>
   | 
   |<funcsynopsis>
 5 |<funcsynopsisinfo>
   |#include &lt;varargs.h&gt;
   |</funcsynopsisinfo>
   |<funcprototype>
   |  <funcdef>int <function>max</function></funcdef>
10 |  <varargs/>
   |</funcprototype>
   |</funcsynopsis>
   | 
   |</article>

#include <varargs.h>
int max(...);