File: refentry.xml

package info (click to toggle)
docbook-defguide 2.0.17%2Bsvn9912-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, stretch
  • size: 93,428 kB
  • ctags: 299
  • sloc: xml: 396,482; perl: 4,471; python: 879; makefile: 150; sh: 80
file content (69 lines) | stat: -rw-r--r-- 1,740 bytes parent folder | download | duplicates (8)
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
<refentry id="function.element">
<?dbhtml filename="function.html"?>
<refentryinfo>
<pubdate>$Date$</pubdate>
<releaseinfo>$Revision$</releaseinfo>
</refentryinfo>

<refmeta>
<indexterm><primary>elements</primary>
<secondary>function</secondary></indexterm>
<refentrytitle>function</refentrytitle>
<refmiscinfo>Element</refmiscinfo>
</refmeta>
<refnamediv>
<refname>function</refname>
<refpurpose>&function.purpose;</refpurpose>
</refnamediv>

&function.synopsis.gen;
<refsect1 condition='ref.description'><title>Description</title>

<para>
This element marks up the name of a function.  To markup the
parts of a function definition, see <sgmltag>FuncSynopsis</sgmltag>.
</para>

<refsect2><title>Processing expectations</title>
<para>
&format.inline; &pexp.moreinfo;
</para>
<para>
In some environments, the <sgmltag>Function</sgmltag> element generates 
additional punctuation, such as a set of trailing parenthesis.
</para>
</refsect2>

<refsect2 role='fu' revision="4.0"><title>&FutureChanges;</title>
<para>
<!--do not index this occurance-->
&fu.interfacedefinition;
</para>
</refsect2>


&function.parents.gen;
&function.children.gen;
</refsect1>
<refsect1 condition='ref.elem.attrdesc'><title>Attributes</title>
<variablelist>
<varlistentry><term>moreinfo</term>
<listitem>
<para>
If <sgmltag class='attribute'>MoreInfo</sgmltag> is set to <literal>RefEntry</literal>,
it implies that a <sgmltag>RefEntry</sgmltag> exists which further describes the
<sgmltag>Function</sgmltag>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 condition='ref.elem.seealso'><title>See Also</title>
&function.seealso.gen;
</refsect1>
<refsect1><title>Examples</title>

&function.example.seealso.gen;
</refsect1>
</refentry>