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, 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: 4a070f84c9fc7bc85cf9f71d71fa54f4db18f973 a835fdf61c7f87ce1038e2869080d80ea67d3696)