funcsynopsisinfo
funcsynopsisinfo — Information supplementing the FuncDefs of a FuncSynopsis.
Synopsis
- Sequence of:
info? (db.titleforbidden.info)- One of:
- Zero or more of:
- text
lineannotation- Bibliography inlines
![[-]](figs/web/nav/down.gif)
- Computer-output inlines
altanchorannotationbibliorefcocodecommandcomputeroutputconstantemailenvarfilenameindexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectlinkliteralmarkupnonterminalolinkoptionoptionalpackageparameterpromptpropertyremarkreplaceablesubscriptsuperscriptsymbolsystemitemtagtermdeftokenuriuserinputxref
- 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
altanchorannotationbibliorefindexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectlinkolinkremarksubscriptsuperscriptxref
- User-input inlines
accelaltanchorannotationbibliorefcocodecommandcomputeroutputconstantemailenvarfilenameguibuttonguiiconguilabelguimenuguimenuitemguisubmenuindexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectkeycapkeycodekeycombokeysymlinkliteralmarkupmenuchoicemousebuttonnonterminalolinkoptionoptionalpackageparameterpromptpropertyremarkreplaceableshortcutsubscriptsuperscriptsymbolsystemitemtagtermdeftokenuriuserinputxref
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 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.
- 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 ![[+]](figs/web/nav/right.gif)
See Also
funcdef, funcparams, funcprototype, function, paramdef, parameter, returnvalue, varargs, void
Examples
1 <article xmlns='http://docbook.org/ns/docbook'> 2 <title>Example funcsynopsis</title> 4 <funcsynopsis> <funcsynopsisinfo> 6 #include <varargs.h> </funcsynopsisinfo> 8 <funcprototype> <funcdef>int <function>max</function></funcdef> 10 <varargs/> </funcprototype> 12 </funcsynopsis> 14 </article>
#include <varargs.h>
int max(...);