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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 299488 $ -->
<refentry xml:id="function.func-name" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>func_name</refname>
<refpurpose>The func_name purpose</refpurpose>
</refnamediv>
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis role="procedural">
<!-- Example: All functions have this -->
<type>thereturned type</type><methodname>func_name</methodname>
<!-- Example: Required parameter -->
<methodparam><type>param1type</type><parameter>firstparameter</parameter></methodparam>
<!-- Example: Optional parameter, also by reference -->
<methodparam choice="opt"><type>int</type><parameter role="reference">secondparameter</parameter><initializer>defaultvalue</initializer></methodparam>
<!-- Example: If no methodparams exist (void), use this -->
<void />
</methodsynopsis>
<para>
The function description goes here.
</para>
</refsect1><!-- }}} -->
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>firstparameter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>secondparameter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><!-- }}} -->
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
What this function returns, first on success, then failure. If simply
true on success and false on failure, just use &return.success; here.
</para>
</refsect1><!-- }}} -->
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
<para>
When does this function issue E_* level errors, and/or throw exceptions.
</para>
</refsect1><!-- }}} -->
<refsect1 role="unicode"><!-- {{{ -->
&reftitle.unicode;
<para>
Information specific to unicode, from the PHP 6 changes.
</para>
</refsect1><!-- }}} -->
<refsect1 role="changelog"><!-- {{{ -->
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the version of change here</entry>
<entry>
Describe the change
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1><!-- }}} -->
<refsect1 role="examples"><!-- {{{ -->
&reftitle.examples;
<example xml:id="function-name.example.basic"><!-- {{{ -->
<title><function>function-name</function> example</title>
<para>
Any text that describes the purpose of the example, or what
goes on in the example should be here. (Inside the <example> tag, not out).
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding standards';
}
if ($thereisoutput === 'and it is multiple lines') {
echo 'Use a screen like we did below';
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Use the PEAR Coding standards
Use a screen like we did below
]]>
</screen>
</example><!-- }}} -->
</refsect1><!-- }}} -->
<refsect1 role="notes"><!-- {{{ -->
&reftitle.notes;
<caution>
<para>
Any notes that don't fit anywhere else should go here.
90% of the time, notes, warnings or cautions are better placed in the
parameters section. Consider that before using this section!
</para>
</caution>
¬e.language-construct;
¬e.not-bin-safe;
¬e.registerglobals;
</refsect1><!-- }}} -->
<refsect1 role="seealso"><!-- {{{ -->
&reftitle.seealso;
<simplelist>
<member><function>somefunc</function></member>
<member><function>another_func</function></member>
<member>The <link linkend="something">something appendix</link></member>
</simplelist>
</refsect1><!-- }}} -->
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
