DocBook: The Definitive Guide
Prev		Next

FuncDef

Name

FuncDef -- A function (subroutine) name and its return type

Synopsis

Mixed Content Model

FuncDef ::=
((#PCDATA|Replaceable|Function)*)

Attributes

Common attributes

Tag Minimization

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

Description

A FuncDef contains the name of a programming language function, and its return type.

Within the FuncDef, the function name is identified with Function, and the rest of the content is assumed to be the return type.

In the following definition, max is the name of the function and int is the return type:

<funcdef>int <function>max</function></funcdef>

Processing expectations

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

Parents

These elements contain FuncDef: FuncPrototype, FuncSynopsis.

Children

The following elements occur in FuncDef: Function, 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>rand</function></funcdef>
  <void>
</funcprototype>
</funcsynopsis>

int rand(void);

For additional examples, see also FuncSynopsis, ParamDef, VarArgs.

Prev	Home	Next
FormalPara	Up	FuncParams


	DocBook: The Definitive Guide By Norman Walsh & Leonard Muellner 1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM

DocBook: The Definitive Guide