DocBook 5: The Definitive Guide

Name

VarArgs -- An empty element in a function synopsis indicating a variable number of arguments

Synopsis

Content Model

VarArgs ::= EMPTY

Attributes

Common attributes

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.

Description

VarArgs indicates that a function takes a variable number of arguments.

Processing expectations

The VarArgs element produces generated text that indicates that the function takes a variable number of arguments. The exact generated text may vary. One common result is "(…)".

Parents

These elements contain VarArgs: FuncPrototype, FuncSynopsis.

Children

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

See Also

FuncDef, FuncParams, FuncPrototype, FuncSynopsisInfo, Function, ParamDef, Parameter, ReturnValue, Void

Examples

<!DOCTYPE funcsynopsis PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <funcsynopsis> <funcsynopsisinfo> #include &lt;varargs.h&gt; </funcsynopsisinfo> <funcprototype> <funcdef>int <function>max</function></funcdef> <varargs> </funcprototype> </funcsynopsis>

#include <varargs.h>

int max(...);

For additional examples, see also FuncSynopsis.

Back to: DocBook: The Definitive Guide