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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 325397 $ -->
<phpdoc:classref xml:id="class.classname"
xmlns:phpdoc="http://php.net/ns/phpdoc"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns="http://docbook.org/ns/docbook">
<title>The ClassName class</title>
<titleabbrev>ClassName</titleabbrev>
<partintro>
<!-- {{{ ClassName intro -->
<section xml:id="classname.intro">
&reftitle.intro;
<para>
Description of the class.
</para>
</section>
<!-- }}} -->
<section xml:id="classname.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>ClassName</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>ClassName</classname>
</ooclass>
<!-- If the class extends another one, use this
<ooclass>
<modifier>extends</modifier>
<classname>BaseClassName</classname>
</ooclass>
-->
<!-- If the class implements an interface, or two, use this (one oointerface element per interface)
<oointerface>
<interfacename>InterfaceName</interfacename>
</oointerface>
-->
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<!-- If the property is documented below (xml:id=classname.props) use this
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="classname.props.name">name</varname>
</fieldsynopsis>
-->
<!-- If properties are documented "as a method", use this
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:fieldsynopsis)" />
-->
<!-- Edit the classname below -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[not(@role='procedural')])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback />
</xi:include>
<!-- If the class extends a class use this. Repeat the <xi:include> tag for all the parent classes in the event of multiple extensions; i.e. class XYZ extends class XY and class XY extends class X
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.baseclassname')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural') and not(modifier='private')])" />
</classsynopsis>
-->
<!-- }}} -->
</section>
<!-- {{{ ClassName properties
<section xml:id="classname.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="classname.props.name">
<term><varname>name</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
</variablelist>
</section>
-->
<!-- }}} -->
</partintro>
&reference.extname.entities.classname;
</phpdoc:classref>
<!-- 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
-->
|
