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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
<RefEntry ID="dbre.elem.FuncDef">
<!-- Created by DTDParseRefentry version 0.94 -->
<!-- Consult http://www.ora.com/homepages/dtdparse/ -->
<!-- for more information. -->
<![ %dbre.ms.refmeta [
<RefMeta>
<IndexTerm><Primary>FuncDef Element</Primary></IndexTerm>
<RefEntryTitle>FuncDef</RefEntryTitle>
<RefMiscInfo>Element</RefMiscInfo>
</RefMeta>
]]>
<RefNameDiv>
<RefName>FuncDef</RefName>
<RefPurpose>
Function or routine name
and its return type in a FuncSynopsis
</RefPurpose>
</RefNameDiv>
<![ %dbre.ms.refsynopsisdiv [
<RefSynopsisDiv><Title>Content Model</Title>
<Synopsis>
(#PCDATA | <Link LinkEnd="dbre.elem.Replaceable">Replaceable</Link> | <Link LinkEnd="dbre.elem.Function">Function</Link>)*
</Synopsis>
<![ %dbre.ms.refsynopsisdiv.attr [
<RefSect2><Title>Attributes</Title>
<Para>
This element has <link linkend="dbre.x.common">common</link> and <link linkend="dbre.x.role"><sgmltag class=attribute>Role</></link> attributes.
</Para>
</RefSect2>
]]>
<![ %dbre.ms.refsynopsisdiv.tagmin [
<RefSect2><Title>Tag Minimization</Title>
<Para>
Both the start- and end-tags are required for this element.
</Para>
</RefSect2>
]]>
</RefSynopsisDiv>
]]>
<![ %dbre.ms.description [
<RefSect1><Title>Description</Title>
<para>Function or routine name
and its return type in a FuncSynopsis
Like Paramdef, FuncDef provides
data type information and the name of the
Function (or Parameter, in the case of ParamDef)
this information applies
to. A FuncDef may contain any combination of
plain text, Replaceable, Data, or Function, in any order.
It has common attributes.
</para>
<para>Separating this information from the rest of
the synopsis avoids messing with data type
information that appears before <emphasis>or after</emphasis>
the item it applies to, such as array
information ("[]"). It also avoids the issue of
placing the pointer ("*") indicator (next to the rest of
the left-hand data type or next to the Parameter or Function
name?). Any spaces that surround the
Parameter or Function must be inserted by the writer.
</para>
<![ %dbre.ms.description.parents [
<RefSect2><Title>Parents</Title>
<Para>
These elements contain FuncDef:
<SimpleList Type=Inline>
<Member><Link LinkEnd="dbre.elem.FuncPrototype">FuncPrototype</Link></Member>
<Member><Link LinkEnd="dbre.elem.FuncSynopsis">FuncSynopsis</Link></Member>
</SimpleList>.
</Para>
</RefSect2>
]]>
<![ %dbre.ms.description.children [
<RefSect2><Title>Children</Title>
<Para>
FuncDef contains these elements:
<SimpleList Type=Inline>
<Member><Link LinkEnd="dbre.elem.Function">Function</Link></Member>
<Member>#PCDATA</Member>
<Member><Link LinkEnd="dbre.elem.Replaceable">Replaceable</Link></Member>
</SimpleList>.
</Para>
</RefSect2>
]]>
</RefSect1>
]]>
<![ %dbre.ms.examples [
<RefSect1><Title>Examples</Title>
<programlisting>
<![ CDATA [
<FUNCSYNOPSIS>
<FUNCSYNOPSISINFO>#include <stdlib.h></FUNCSYNOPSISINFO>
<FUNCDEF>double <FUNCTION>atof</FUNCTION></FUNCDEF>
<PARAMDEF>const char *<PARAMETER>nptr</PARAMETER></PARAMDEF>
</FUNCSYNOPSIS>
]]>
</programlisting>
<programlisting>
<![ CDATA [
<FUNCSYNOPSIS>
<FUNCSYNOPSISINFO>TODO TBS
</FUNCSYNOPSISINFO>
<FUNCPROTOTYPE>
<FUNCDEF>TODO TBS
</FUNCDEF>
<VOID>
</FUNCPROTOTYPE>
</FUNCSYNOPSIS>
]]>
</programlisting>
</RefSect1>
]]>
</RefEntry>
|
