funcdef
funcdef — A function (subroutine) name and its return type.
Synopsis
- Zero or more of:
- text
function
phrase
(db._phrase)replaceable
type
- Graphic inlines
- Indexing inlines
- Linking inlines
- Ubiquitous inlines
alt
anchor
annotation
biblioref
indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)inlinemediaobject
link
olink
remark
subscript
superscript
xref
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
.
Parents
These elements contain funcdef
: funcprototype
.
This element contains 18 elements.
See Also
funcparams
, funcprototype
, funcsynopsisinfo
, function
, paramdef
, parameter
, returnvalue
, varargs
, void
Examples
1 <article xmlns='http://docbook.org/ns/docbook'> 2 <title>Example funcdef</title> 4 <funcsynopsis> <funcprototype> 6 <funcdef>int <function>rand</function></funcdef> <void/> 8 </funcprototype> </funcsynopsis> 10 </article>
int rand(
)
;