ParamDef

DocBook: The Definitive Guide
Prev		Next

Synopsis

Mixed Content Model

ParamDef ::=
((#PCDATA|Replaceable|Parameter|FuncParams)*)

Attributes

Common attributes

Tag Minimization

Both the start- and end-tags are required for this element.

Description

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>

Processing expectations

Formatted inline. For a complete description of the processing expectations, see FuncSynopsis.

Parents

These elements contain ParamDef: FuncPrototype, FuncSynopsis.

Children

The following elements occur in ParamDef: FuncParams, Parameter, Replaceable.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

Examples

<!DOCTYPE funcsynopsis PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<funcsynopsis>
<funcprototype>
  <funcdef>int <function>max</function></funcdef>
  <paramdef>int <parameter>int1</parameter></paramdef>
  <paramdef>int <parameter>int2</parameter></paramdef>
</funcprototype>
</funcsynopsis>

int max(int int1, int int2);

For additional examples, see also FuncDef, FuncSynopsis.

DocBook: The Definitive Guide