funcdef

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

Synopsis

funcdef ::= [-]

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.

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, trademark, type, void, wordasword, xref.

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example funcdef</title>

<funcsynopsis>
<funcprototype>
<funcdef>int <function>rand</function></funcdef>
  <void/>
</funcprototype>
</funcsynopsis>

</article>

int rand();

Last revised by Norman Walsh on (git hash: c3457cab689d8fd89ba4252de204cf9a14e40acd 6a501344525f32f9834f0e4a5c3c3f8131803fa4 47fe34b28bad7941a61b9c1c17d47f6eed36cd04)