From d41f9c2347e53ade9538a0adc0dca7e75008020b Mon Sep 17 00:00:00 2001 From: Peter Cowburn Date: Wed, 23 Sep 2009 18:59:41 +0000 Subject: [PATCH] Filling out InfiniteIterator documentation git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288618 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/spl/infiniteiterator.xml | 5 +- reference/spl/infiniteiterator/construct.xml | 54 +++++++++++++++++--- reference/spl/infiniteiterator/next.xml | 16 +++--- 3 files changed, 61 insertions(+), 14 deletions(-) diff --git a/reference/spl/infiniteiterator.xml b/reference/spl/infiniteiterator.xml index 5375b29e00..2706f0868f 100644 --- a/reference/spl/infiniteiterator.xml +++ b/reference/spl/infiniteiterator.xml @@ -12,8 +12,9 @@
&reftitle.intro; - This Iterator takes another Iterator and infinitely iterates it - by rewinding it when its end is reached. + The InfiniteIterator allows one to + infinitely iterate over an iterator without having to manually + rewind the iterator upon reaching its end.
diff --git a/reference/spl/infiniteiterator/construct.xml b/reference/spl/infiniteiterator/construct.xml index 056dc5dc7d..c8dc33c09a 100644 --- a/reference/spl/infiniteiterator/construct.xml +++ b/reference/spl/infiniteiterator/construct.xml @@ -4,7 +4,7 @@ InfiniteIterator::__construct - Constructs an infiniteIterator + Constructs an InfiniteIterator @@ -14,11 +14,10 @@ Iteratoriterator - Constructs an infinite iterator. + Constructs an InfiniteIterator + from an Iterator. - &warn.undocumented.func; - @@ -29,7 +28,7 @@ iterator - The passed in iterator. + The iterator to infinitely iterate over. @@ -40,7 +39,50 @@ &reftitle.returnvalues; - An infinite iterator. + &return.void; + + + + + &reftitle.errors; + + Throws an E_RECOVERABLE_ERROR if the + iterator parameter is not + an Iterator. + + + + + &reftitle.examples; + + + <function>InfiniteIterator::__construct</function> example + + +]]> + + &example.outputs; + + + + diff --git a/reference/spl/infiniteiterator/next.xml b/reference/spl/infiniteiterator/next.xml index 90d41137e9..47215ceb5d 100644 --- a/reference/spl/infiniteiterator/next.xml +++ b/reference/spl/infiniteiterator/next.xml @@ -4,7 +4,7 @@ InfiniteIterator::next - Moves the Iterator forward + Moves the inner Iterator forward or rewinds it @@ -14,11 +14,15 @@ - Moves the inner Iterator forward to its next element, or rewind it. + Moves the inner Iterator forward to its next element if there is one, + otherwise rewinds the inner Iterator back to the beginning. - - &warn.undocumented.func; - + + + Even an InfiniteIterator stops if + its inner Iterator is empty. + + @@ -37,7 +41,7 @@ &reftitle.seealso; - Infinite::Iterator + InfiniteIterator::__construct