cvs: phpdoc /en/reference/spl infiniteiterator.xml iterators.xml /en/reference/spl/infiniteiterator construct.xml next.xml
| From: | Philip Olson | Date: | Tue, 30 Jun 2009 00:54:36 +0000 |
| Subject: | cvs: phpdoc /en/reference/spl infiniteiterator.xml iterators.xml /en/reference/spl/infiniteiterator construct.xml next.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-4283@lists.php.net to get a copy of this message | ||
philip Tue Jun 30 00:54:36 2009 UTC
Added files:
/phpdoc/en/reference/spl infiniteiterator.xml
/phpdoc/en/reference/spl/infiniteiterator construct.xml next.xml
Modified files:
/phpdoc/en/reference/spl iterators.xml
Log:
added doc skeletons for infiniteIterator
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/iterators.xml?r1=1.6&r2=1.7&diff_format=u
Index: phpdoc/en/reference/spl/iterators.xml
diff -u phpdoc/en/reference/spl/iterators.xml:1.6 phpdoc/en/reference/spl/iterators.xml:1.7
--- phpdoc/en/reference/spl/iterators.xml:1.6 Tue Jun 30 00:35:01 2009
+++ phpdoc/en/reference/spl/iterators.xml Tue Jun 30 00:54:36 2009
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
<part xml:id="spl.iterators" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -13,7 +13,6 @@
<section xml:id="spl.iterators.list">
<title>Undocumented Iterators</title>
<simplelist>
- <member><classname>InfiniteIterator</classname></member>
<member><classname>MultipleIterator</classname></member>
<member><classname>NoRewindIterator</classname></member>
<member><classname>RecursiveArrayIterator</classname></member>
@@ -27,7 +26,6 @@
</partintro>
<!-- TODO: Not documented
- &reference.spl.infiniteiterator;
&reference.spl.multipleiterator;
&reference.spl.norewinditerator;
&reference.spl.recursivearrayiterator;
@@ -45,6 +43,7 @@
&reference.spl.filesystemiterator;
&reference.spl.filteriterator;
&reference.spl.globiterator;
+ &reference.spl.infiniteiterator;
&reference.spl.iteratoriterator;
&reference.spl.limititerator;
&reference.spl.parentiterator;
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/infiniteiterator.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/spl/infiniteiterator.xml
+++ phpdoc/en/reference/spl/infiniteiterator.xml
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<phpdoc:classref xml:id="class.infiniteiterator" 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">
<title>The InfiniteIterator class</title>
<titleabbrev>InfiniteIterator</titleabbrev>
<partintro>
<!-- {{{ InfiniteIterator intro -->
<section xml:id="infiniteiterator.intro">
&reftitle.intro;
<para>
This Iterator takes another Iterator and infinitely iterates it
by rewinding it when its end is reached.
</para>
</section>
<!-- }}} -->
<section xml:id="infiniteiterator.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>InfiniteIterator</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>InfiniteIterator</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>IteratorIterator</classname>
</ooclass>
<oointerface>
<interfacename>OuterIterator</interfacename>
</oointerface>
<oointerface>
<interfacename>Traversable</interfacename>
</oointerface>
<oointerface>
<interfacename>Iterator</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
xpointer(id('class.infiniteiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"
/>
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
xpointer(id('class.iteratoriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"
/>
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.spl.entities.infiniteiterator;
</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:"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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/infiniteiterator/construct.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/spl/infiniteiterator/construct.xml
+++ phpdoc/en/reference/spl/infiniteiterator/construct.xml
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="infiniteiterator.construct" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>InfiniteIterator::__construct</refname>
<refpurpose>Constructs an infiniteIterator</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>InfiniteIterator::__construct</methodname>
<methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam>
</methodsynopsis>
<para>
Constructs an infinite iterator.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>iterator</parameter></term>
<listitem>
<para>
The passed in iterator.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An infinite iterator.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>InfiniteIterator::next</methodname></member>
</simplelist>
</para>
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/infiniteiterator/next.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/spl/infiniteiterator/next.xml
+++ phpdoc/en/reference/spl/infiniteiterator/next.xml
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="infiniteiterator.next" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>InfiniteIterator::next</refname>
<refpurpose>Moves the Iterator forward</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<type>void</type><methodname>InfiniteIterator::next</methodname>
<void />
</methodsynopsis>
<para>
Moves the inner Iterator forward to its next element, or rewind it.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>Infinite::Iterator</methodname></member>
</simplelist>
</para>
</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:"../../../../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
-->