function

$Revision: 1666 $

$Date: 2002-06-12 07:19:37 -0400 (Wed, 12 Jun 2002) $

function — The name of a function or subroutine, as in a programming language

Synopsis

Mixed Content Model

function ::=
(%cptr.char.mix;)*

Attributes

Common attributes

Name

Type

Default

moreinfo
Enumeration:
none
refentry
"none"

Parameter Entities

The following parameter entities contain function:

Parameter Entities
%cptr.char.mix;%ndxterm.char.mix;%para.char.mix;
%refinline.char.mix;%refname.char.mix;%tbl.entry.mdl;
%tech.char.class;%title.char.mix; 

Description

This element marks up the name of a function. To markup the parts of a function definition, see FuncSynopsis.

Processing expectations

Formatted inline. The MoreInfo attribute can help generate a link or query to retrieve additional information.

In some environments, the Function element generates additional punctuation, such as a set of trailing parenthesis.

Future Changes

The InterfaceDefinition element will be discarded in DocBook V4.0. It will no longer be available in the content model of this element.

Attributes

moreinfo

If MoreInfo is set to RefEntry, it implies that a RefEntry exists which further describes the Function.

See Also

funcdef, funcparams, funcprototype, funcsynopsisinfo, paramdef, parameter, returnvalue, varargs, void.

Examples

For examples, see funcdef, funcparams, funcsynopsis, paramdef, programlistingco, refentry, returnvalue, structname, type, varargs.