Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 6178255

Browse files
author
Joris van de Sande
committed
- Added documentation for OuterIterator interface (without examples at the moment)
- Updated description for RecursiveIterator interface - Updated description for RecursiveIteratorIterator class git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@287818 c90b9560-bf6c-de11-be94-00142212c4b1
1 parent ac6a20a commit 6178255

5 files changed

Lines changed: 151 additions & 18 deletions

File tree

‎reference/spl/interfaces.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@
2929
</partintro>
3030

3131
&reference.spl.countable;
32+
&reference.spl.outeriterator;
3233
&reference.spl.recursiveiterator;
3334
&reference.spl.seekableiterator;
3435
<!-- TODO: Not documented
35-
&reference.spl.outeriterator;
3636
&reference.spl.splobserver;
3737
&reference.spl.splsubject;
3838
-->

‎reference/spl/outeriterator.xml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision: 283837 $ -->
3+
4+
<phpdoc:classref xml:id="class.outeriterator" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
5+
6+
<title>The OuterIterator interface</title>
7+
<titleabbrev>OuterIterator</titleabbrev>
8+
9+
<partintro>
10+
11+
<!-- {{{ OuterIterator intro -->
12+
<section xml:id="outeriterator.intro">
13+
&reftitle.intro;
14+
<para>
15+
Classes implementing <classname>OuterIterator</classname> can be used to iterate
16+
over iterators.
17+
</para>
18+
</section>
19+
<!-- }}} -->
20+
21+
<section xml:id="outeriterator.synopsis">
22+
&reftitle.interfacesynopsis;
23+
24+
<!-- {{{ Synopsis -->
25+
<classsynopsis>
26+
<ooclass><classname>OuterIterator</classname></ooclass>
27+
28+
<!-- {{{ Class synopsis -->
29+
<classsynopsisinfo>
30+
<ooclass>
31+
<classname>OuterIterator</classname>
32+
</ooclass>
33+
34+
<ooclass>
35+
<modifier>extends</modifier>
36+
<classname>Iterator</classname>
37+
</ooclass>
38+
39+
</classsynopsisinfo>
40+
<!-- }}} -->
41+
42+
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
43+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.outeriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
44+
45+
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
46+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.iterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
47+
</classsynopsis>
48+
<!-- }}} -->
49+
50+
</section>
51+
52+
</partintro>
53+
54+
&reference.spl.entities.outeriterator;
55+
56+
</phpdoc:classref>
57+
58+
<!-- Keep this comment at the end of the file
59+
Local variables:
60+
mode: sgml
61+
sgml-omittag:t
62+
sgml-shorttag:t
63+
sgml-minimize-attributes:nil
64+
sgml-always-quote-attributes:t
65+
sgml-indent-step:1
66+
sgml-indent-data:t
67+
indent-tabs-mode:nil
68+
sgml-parent-document:nil
69+
sgml-default-dtd-file:"manual.ced"
70+
sgml-exposed-tags:nil
71+
sgml-local-catalogs:nil
72+
sgml-local-ecat-files:nil
73+
End:
74+
vim600: syn=xml fen fdm=syntax fdl=2 si
75+
vim: et tw=78 syn=sgml
76+
vi: ts=1 sw=1
77+
-->
78+

‎reference/spl/outeriterator/getinneriterator.xml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision: 283837 $ -->
3+
<refentry xml:id="outeriterator.getchildren" xmlns="http://docbook.org/ns/docbook">
4+
<refnamediv>
5+
<refname>OuterIterator::getInnerIterator</refname>
6+
<refpurpose>Returns the inner iterator for the current entry.</refpurpose>
7+
</refnamediv>
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<methodsynopsis>
11+
<modifier>public</modifier> <type>Iterator</type><methodname>OuterIterator::getInnerIterator</methodname>
12+
<void/>
13+
</methodsynopsis>
14+
<para>
15+
Returns the inner iterator for the current iterator entry.
16+
</para>
17+
</refsect1>
18+
19+
<refsect1 role="parameters">
20+
&reftitle.parameters;
21+
&no.function.parameters;
22+
</refsect1>
23+
24+
<refsect1 role="returnvalues">
25+
&reftitle.returnvalues;
26+
<para>
27+
The inner iterator for the current entry.
28+
</para>
29+
</refsect1>
30+
31+
</refentry>
32+
33+
<!-- Keep this comment at the end of the file
34+
Local variables:
35+
mode: sgml
36+
sgml-omittag:t
37+
sgml-shorttag:t
38+
sgml-minimize-attributes:nil
39+
sgml-always-quote-attributes:t
40+
sgml-indent-step:1
41+
sgml-indent-data:t
42+
indent-tabs-mode:nil
43+
sgml-parent-document:nil
44+
sgml-default-dtd-file:"../../../../manual.ced"
45+
sgml-exposed-tags:nil
46+
sgml-local-catalogs:nil
47+
sgml-local-ecat-files:nil
48+
End:
49+
vim600: syn=xml fen fdm=syntax fdl=2 si
50+
vim: et tw=78 syn=sgml
51+
vi: ts=1 sw=1
52+
-->

‎reference/spl/recursiveiterator.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
&reftitle.intro;
1414
<para>
1515
Classes implementing <classname>RecursiveIterator</classname> can be used to iterate
16-
over iterators.
16+
over iterators recursively.
1717
</para>
1818
</section>
1919
<!-- }}} -->

‎reference/spl/recursiveiteratoriterator.xml‎

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,25 @@
33
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.recursiveiteratoriterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
44
<title>The RecursiveIteratorIterator class</title>
55
<titleabbrev>RecursiveIteratorIterator</titleabbrev>
6-
6+
77
<partintro>
8-
8+
99
<!-- {{{ RecursiveIteratorIterator intro -->
1010
<section xml:id="recursiveiteratoriterator.intro">
1111
&reftitle.intro;
1212
<para>
13-
...
13+
Can be used to iterate through recursive iterators.
1414
</para>
1515
</section>
1616
<!-- }}} -->
17-
17+
1818
<section xml:id="recursiveiteratoriterator.synopsis">
1919
&reftitle.classsynopsis;
20-
20+
2121
<!-- {{{ Synopsis -->
2222
<classsynopsis>
2323
<ooclass><classname>RecursiveIteratorIterator</classname></ooclass>
24-
24+
2525
<!-- {{{ Class synopsis -->
2626
<classsynopsisinfo>
2727
<ooclass>
@@ -31,18 +31,18 @@
3131
<oointerface>
3232
<interfacename>OuterIterator</interfacename>
3333
</oointerface>
34-
34+
3535
<oointerface>
3636
<interfacename>Traversable</interfacename>
3737
</oointerface>
38-
38+
3939
<oointerface>
4040
<interfacename>Iterator</interfacename>
4141
</oointerface>
4242

4343
</classsynopsisinfo>
4444
<!-- }}} -->
45-
45+
4646
<!-- {{{ If the property is documented below (xml:id=recursiveiteratoriterator.props) use this
4747
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
4848
<fieldsynopsis>
@@ -51,13 +51,16 @@
5151
<varname linkend="recursiveiteratoriterator.props.name">name</varname>
5252
</fieldsynopsis>
5353
}}} -->
54-
54+
5555
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
5656
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.recursiveiteratoriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
57+
58+
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
59+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.outeriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
5760
</classsynopsis>
58-
61+
5962
</section>
60-
63+
6164
<!-- {{{ RecursiveIteratorIterator properties
6265
<section xml:id="recursiveiteratoriterator.props">
6366
&reftitle.properties;
@@ -71,13 +74,13 @@
7174
</variablelist>
7275
</section>
7376
}}} -->
74-
77+
7578
</partintro>
76-
79+
7780
&reference.spl.entities.recursiveiteratoriterator;
78-
81+
7982
</phpdoc:classref>
80-
83+
8184
<!-- Keep this comment at the end of the file
8285
Local variables:
8386
mode: sgml

0 commit comments

Comments
 (0)