funcdef
funcdef — A function (subroutine) name and its return type.
Synopsis
- Zero or more of:
- text
function
replaceable
type
- Graphic inlines
- Indexing inlines
- Linking inlines
- Ubiquitous inlines
abbrev
acronym
alt
anchor
annotation
biblioref
coref
date
emphasis
(db._emphasis)firstterm
(db._firstterm)footnote
footnoteref
foreignphrase
(db._foreignphrase)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
subscript
superscript
trademark
wordasword
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 31 elements.
See Also
funcparams
, funcprototype
, funcsynopsisinfo
, function
, paramdef
, parameter
, returnvalue
, varargs
, void
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(
)
;