From 63e08f1f1b85486724c6607b4f17a862f1610746 Mon Sep 17 00:00:00 2001
From: Philip Olson <philip@php.net>
Date: Tue, 30 Jun 2009 00:54:36 +0000
Subject: [PATCH] added doc skeletons for infiniteIterator

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@283087 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/spl/infiniteiterator.xml           | 89 ++++++++++++++++++++
 reference/spl/infiniteiterator/construct.xml | 77 +++++++++++++++++
 reference/spl/infiniteiterator/next.xml      | 66 +++++++++++++++
 reference/spl/iterators.xml                  |  5 +-
 4 files changed, 234 insertions(+), 3 deletions(-)
 create mode 100644 reference/spl/infiniteiterator.xml
 create mode 100644 reference/spl/infiniteiterator/construct.xml
 create mode 100644 reference/spl/infiniteiterator/next.xml

diff --git a/reference/spl/infiniteiterator.xml b/reference/spl/infiniteiterator.xml
new file mode 100644
index 0000000000..403428925d
--- /dev/null
+++ b/reference/spl/infiniteiterator.xml
@@ -0,0 +1,89 @@
+<?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
+-->
diff --git a/reference/spl/infiniteiterator/construct.xml b/reference/spl/infiniteiterator/construct.xml
new file mode 100644
index 0000000000..e710a59a61
--- /dev/null
+++ b/reference/spl/infiniteiterator/construct.xml
@@ -0,0 +1,77 @@
+<?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
+-->
diff --git a/reference/spl/infiniteiterator/next.xml b/reference/spl/infiniteiterator/next.xml
new file mode 100644
index 0000000000..3e9c8f4573
--- /dev/null
+++ b/reference/spl/infiniteiterator/next.xml
@@ -0,0 +1,66 @@
+<?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
+-->
diff --git a/reference/spl/iterators.xml b/reference/spl/iterators.xml
index 384ff7d760..be812b3223 100644
--- a/reference/spl/iterators.xml
+++ b/reference/spl/iterators.xml
@@ -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;