Create a documentation package for Iterators

Author: bvontob

CallbackTransformIterator.php

@@ -3,6 +3,11 @@
  * Class CallbackTransformIterator implements an Iterator that transforms
  * the values of another Iterator through a callback provided from the
  * outside.
+ *
+ * @author     Beat Vontobel
+ * @since      2011-11-22
+ * @package    MeteoNews\phplib
+ * @subpackage Iterators
  */
 
 class CallbackTransformIterator extends IteratorIterator

CartesianProductIterator.php

@@ -3,13 +3,22 @@
  * Class CartesianProductIterator implements an Iterator that iterates over two
  * Iterators, returning all the values of the second Iterator for every value
  * of the first Iterator, aka performing a cartesian product or a CROSS JOIN as
- * it would be called in SQL. Each joined value of the product is returned as
- * an array of the two values like this:
+ * it would be called in SQL.
  *
- *   array(valueFrom1stIterator, valueFrom2ndIterator)
+ * Each joined value of the product is returned as an array of the two
+ * values like this:
+ *
+ *   <code>
+ *     array(valueFrom1stIterator, valueFrom2ndIterator)
+ *   </code>
  *
  * The keys of the Iterators are discarded, this class will instead return a
  * sequential numeric key.
+ *
+ * @author     Beat Vontobel
+ * @since      2011-11-24
+ * @package    MeteoNews\phplib
+ * @subpackage Iterators
  */
 
 class CartesianProductIterator extends IteratorIterator

SplitIterator.php

@@ -1,6 +1,13 @@
 <?php
 require_once("SplitIterator/SplitInnerIterator.php");
 
+/**
+ *
+ * @author     Beat Vontobel
+ * @since      2015-05-20
+ * @package    MeteoNews\phplib
+ * @subpackage Iterators
+ */
 abstract class SplitIterator extends IteratorIterator {
   abstract public function needsSplit($key, $value);
 

SplitIterator/SplitInnerIterator.php

@@ -8,6 +8,11 @@
  * iterator, and rewinding it would also mess with the state of the
  * outer iterator).
  *
+ * @author     Beat Vontobel
+ * @since      2015-05-20
+ * @package    MeteoNews\phplib
+ * @subpackage Iterators
+ *
  * @see SplitIterator
  */
 class SplitInnerIterator extends NoRewindIterator {

traitIteratorCountableEmpty.php

@@ -15,8 +15,10 @@
  * Just saves you some typing for Mock-Ups, test cases, or other
  * classes that will never contain anything.
  *
- * @author Beat Vontobel
- * @since  2015-04-01
+ * @author     Beat Vontobel
+ * @since      2015-04-01
+ * @package    MeteoNews\phplib
+ * @subpackage Iterators
  */
 trait traitIteratorCountableEmpty {
   public function count() {