Name
funcdef — A function (subroutine) name and its return type
Synopsis
funcdef ::=
(text | function
|
phrase
db._phrase | replaceable
| type
| Graphic inlines | Indexing inlines | Linking inlines | Ubiquitous inlines)*
Attribute synopsis
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
.
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>
Get DocBook 5: The Definitive Guide now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.