1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
<refentry id="funcdef.element">
<?dbhtml filename="funcdef.html"?>
<refentryinfo>
<pubdate>$Date$</pubdate>
<releaseinfo>$Revision$</releaseinfo>
</refentryinfo>
<refmeta>
<indexterm><primary>elements</primary>
<secondary>funcdef</secondary></indexterm>
<refentrytitle>funcdef</refentrytitle>
<refmiscinfo>Element</refmiscinfo>
</refmeta>
<refnamediv>
<refname>funcdef</refname>
<refpurpose>&funcdef.purpose;</refpurpose>
</refnamediv>
&funcdef.synopsis.gen;
<refsect1 condition='ref.description'><title>Description</title>
<para>
A <sgmltag>FuncDef</sgmltag> contains the name of a programming language function,
and its return type.
</para>
<para>
Within the <sgmltag>FuncDef</sgmltag>, the function name is identified with
<sgmltag>Function</sgmltag>, and the rest of the content is assumed to be the
return type.
</para>
<para>
In the following definition, <function>max</function> is the name of the
function and <type>int</type> is the return type:
<screen>
<![CDATA[
<funcdef>int <function>max</function></funcdef>
]]>
</screen>
</para>
<refsect2><title>Processing expectations</title>
<para>
&format.inline; For a complete description of the processing expecations,
see <sgmltag>FuncSynopsis</sgmltag>.
</para>
</refsect2>
&funcdef.parents.gen;
&funcdef.children.gen;
</refsect1>
<refsect1 condition='ref.elem.seealso'><title>See Also</title>
&funcdef.seealso.gen;
</refsect1>
<refsect1><title>Examples</title>
<informalexample role="example-source">
<programlisting>&funcdef.example.1.txt;</programlisting>
</informalexample>
<anchor id="ex.os.funcdef.1" role="HACK-ex.out.start"/>
&funcdef.example.1.gen;
<anchor id="ex.oe.funcdef.1" role="HACK-ex.out.end"/>
&funcdef.example.seealso.gen;
</refsect1>
</refentry>
|
