    |
DocBook: The Definitive Guide 0.0.25 for DocBook V5.0 (Alpha) |
| |
DocBook: The Definitive Guide 0.0.25 for DocBook V5.0 (Alpha) |
paramdef — Information about a function parameter in a programming language
paramdef ::= ![[-]](graphics/down.gif)
![[+]](graphics/right.gif)
funcparamsinitializerparameterphrase (db._phrase)replaceabletype
altanchorannotationbibliorefindexterm (db.indexterm.endofrange)indexterm (db.indexterm.singular)indexterm (db.indexterm.startofrange)inlinemediaobjectlinkolinkremarksubscriptsuperscriptxrefCommon attributes and common linking attributes.
Additional attributes:
In the syntax summary for a function in a programming language, paramdef provides the description of a parameter to the function. Typically, this includes the data type of the parameter and its name. For parameters that are pointers to functions, it also includes a summary of the nested parameters.
Within the paramdef, the parameter name is identified with parameter, and the rest of the content is assumed to be the data type.
In the following definition, str is the name of the parameter and char * is its type:
<paramdef>char *<parameter>str</parameter></paramdef>
Sometimes a data type requires punctuation on both sides of the parameter. For example, the a parameter in this definition is an array of char *:
<paramdef>char *<parameter>a</parameter>[]</paramdef>
Formatted inline. For a complete description of the processing expectations, see funcsynopsis.
Common attributes and common linking attributes.
Indicates optionality.
| Enumerated values: | |
|---|---|
| “opt” |
Formatted to indicate that it is optional. |
| “req” |
Formatted to indicate that it is required. |
The following elements occur in paramdef: text, alt, anchor, annotation, biblioref, funcparams, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), initializer, inlinemediaobject, link, olink, parameter, phrase (db._phrase), remark, replaceable, subscript, superscript, type, xref.
funcdef, funcparams, funcprototype, funcsynopsisinfo, function, parameter,
returnvalue, varargs, void<article xmlns='http://docbook.org/ns/docbook'> <title>Example paramdef</title> <funcsynopsis> <funcprototype> <funcdef>int <function>max</function></funcdef> <paramdef>int <parameter>int1</parameter></paramdef> <paramdef>int <parameter>int2</parameter></paramdef> </funcprototype> </funcsynopsis> </article>
int max( |
int1, | |
int2); |
int |
int1; |
int |
int2; |
| |
|
|
| para | |
parameter |