funcdef

funcdef — A function (subroutine) name and its return type.

Synopsis

funcdef ::=

Attributes

Common attributes and common linking attributes.

No additional attributes.

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 expectations, see funcsynopsis.

Attributes

Common attributes and common linking attributes.

any attribute

Any attribute in any other explicit namespace

Parents

These elements contain funcdef: funcprototype.

Children

The following elements occur in funcdef: text, abbrev, acronym, alt, anchor, annotation, biblioref, coref, date, emphasis (db._emphasis), firstterm (db._firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), function, glossterm (db._glossterm), indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, phrase (db._phrase), quote (db._quote), remark, replaceable, subscript, superscript, templatename, trademark, type, void, wordasword, xref.

See Also

Related elements: funcparams, funcprototype, funcsynopsisinfo, function, paramdef, parameter, returnvalue, varargs, void.

Examples

 1 |<article xmlns='http://docbook.org/ns/docbook'>
   |<title>Example funcdef</title>
   | 
   |<funcsynopsis>
 5 |<funcprototype>
   |<funcdef>int <function>rand</function></funcdef>
   |  <void/>
   |</funcprototype>
   |</funcsynopsis>
10 | 
   |</article>
int rand();