    | DocBook: The Definitive Guide 0.0.12 for DocBook V5.0b1 (Alpha) |
| | DocBook: The Definitive Guide 0.0.12 for DocBook V5.0b1 (Alpha) |
funcsynopsisinfo — Information supplementing the FuncDefs of a FuncSynopsis
funcsynopsisinfo ::=
info? (db.titleforbidden.info)abbrevaccelacronymaltanchorannotationapplicationauthorbibliorefcitationcitebiblioidciterefentrycitetitleclassnamecocodecommandcomputeroutputconstantcorefdatabasedateeditoremailemphasis (db.emphasis)envarerrorcodeerrornameerrortexterrortypeexceptionnamefilenamefirsttermfootnotefootnoterefforeignphrasefunctionglosstermguibuttonguiiconguilabelguimenuguimenuitemguisubmenuhardwarehtml:buttonhtml:fieldsethtml:inputhtml:labelhtml:selecthtml:textareaindexterm (db.indexterm.endofrange)indexterm (db.indexterm.singular)indexterm (db.indexterm.startofrange)initializerinlineequationinlinemediaobjectinterfacenamekeycapkeycodekeycombokeysymlineannotationlinkliteralmarkupmenuchoicemethodnamemodifiermousebuttonnonterminalolinkooclassooexceptionoointerfaceoptionoptionalorgnamepackageparameterpersonnamephrase (db.phrase)productnameproductnumberpromptpropertyquoteremarkreplaceablereturnvalueshortcutsubscriptsuperscriptsymbolsystemitemtagtermdeftokentrademarktypeuriuserinputvarnamewordaswordxreftextobjectCommon attributes and common linking attributes.
Additional attributes:
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.
This element is displayed “verbatim”; whitespace and linebreaks within this element are significant.
Common attributes and common linking attributes.
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). |
Identifies the language (i.e. programming language) of the verbatim content.
Determines whether lines are numbered.
Enumerated values: | |
|---|---|
| “numbered” | Lines are numbered. |
| “unnumbered” | 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: | |
|---|---|
| “preserve” | Whitespace must be preserved. |
The following elements occur in funcsynopsisinfo: 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), envar, errorcode, errorname, errortext, errortype, exceptionname, filename, firstterm, footnote, footnoteref, foreignphrase, function, glossterm, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, html:button, html:fieldset, html:input, html:label, html:select, html:textarea, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), initializer, inlineequation, inlinemediaobject, interfacename, keycap, keycode, keycombo, keysym, lineannotation, link, literal, markup, menuchoice, methodname, modifier, mousebutton, nonterminal, olink, ooclass, ooexception, oointerface, option, optional, orgname, package, parameter, personname, phrase (db.phrase), productname, productnumber, prompt, property, quote, remark, replaceable, returnvalue, shortcut, subscript, superscript, symbol, systemitem, tag, termdef, textobject, token, trademark, type, uri, userinput, varname, wordasword, xref.
funcdef, funcparams, funcprototype, function, paramdef, parameter, returnvalue, varargs, void<article xmlns='http://docbook.org/ns/docbook'> <title>Example funcsynopsis</title> <funcsynopsis> <funcsynopsisinfo> #include <varargs.h> </funcsynopsisinfo> <funcprototype> <funcdef>int <function>max</function></funcdef> <varargs/> </funcprototype> </funcsynopsis> </article>
#include <varargs.h>
int max(...);
| | | |
| funcsynopsis | | function |