zicht / itertools

src/Zicht/Itertools/itertools.php

Doc Comments +7 added lines, -23 removed lines

@@ -166,8 +166,6 @@ 
  * > chain('ABC', 'DEF')
  * A B C D E F
  *
- * @param array|string|\Iterator $iterable
- * @param array|string|\Iterator $iterable2
  * @return ChainIterator
  */
 function chain(/* $iterable, $iterable2, ... */)
@@ -192,8 +190,8 @@ 
  * > count(2.5, 0.5)
  * 2.5 3.0 3.5 4.0 ...
  *
- * @param int|float $start
- * @param int|float $step
+ * @param integer $start
+ * @param integer $step
  * @return CountIterator
  */
 function count($start = 0, $step = 1)
@@ -217,7 +215,7 @@ 
  * > cycle('ABCD')
  * A B C D A B C D A B C D ...
  *
- * @param array|string|\Iterator $iterable
+ * @param lib\Traits\CycleTrait $iterable
  * @return CycleIterator
  */
 function cycle($iterable)
@@ -299,7 +297,6 @@ 
  *
  * @param null|string|\Closure $strategy
  * @param array|string|\Iterator $iterable
- * @param array|string|\Iterator $iterable2
  * @return MapIterator
  */
 function map($strategy, $iterable /*, $iterable2, ... */)
@@ -455,8 +452,6 @@ 
  * Make an iterator that returns values from $iterable where the
  * $strategy determines that the values are not empty
  *
- * @param null|string|\Closure $strategy, Optional, when not specified !empty will be used
- * @param array|string|\Iterator $iterable
  * @return FilterIterator
  */
 function filter(/* [$strategy, ] $iterable */)
@@ -490,9 +485,6 @@ 
  * TODO: document!
  * TODO: unit tests!
  *
- * @param string|\Closure $strategy
- * @param \Closure $closure Optional, when not specified !empty will be used
- * @param array|string|\Iterator $iterable
  * @return FilterIterator
  *
  * @deprecated Use filter() instead, will be removed in version 3.0
@@ -538,8 +530,6 @@ 
  * > zip([1, 2, 3], ['a', 'b', 'c'])
  * [1, 'a'] [2, 'b'] [3, 'c']
  *
- * @param array|string|\Iterator $iterable
- * @param array|string|\Iterator $iterable2
  * @return ZipIterator
  */
 function zip(/* $iterable, $iterable2, ... */)
@@ -557,7 +547,7 @@ 
 /**
  * Returns an iterable with all the elements from $ITERABLE reversed
  *
- * @param array|string|\Iterator $iterable
+ * @param lib\Traits\ReversedTrait $iterable
  * @return ReversedIterator
  */
 function reversed($iterable)
@@ -578,8 +568,6 @@ 
  * > unique('id', [['id' => 1, 'value' => 'a'], ['id' => 1, 'value' => 'b']])
  * ['id' => 1, 'value' => 'a']  # one element in this list
  *
- * @param null|string|\Closure $strategy
- * @param array|string|\Iterator $iterable
  * @return UniqueIterator
  */
 function unique(/* [$strategy,] $iterable */)
@@ -634,8 +622,6 @@ 
  * > any([1, null, 3])
  * true
  *
- * @param null|string|\Closure $strategy
- * @param array|string|\Iterator $iterable
  * @return boolean
  */
 function any(/* [$strategy,] $iterable */)
@@ -678,8 +664,6 @@ 
  * > all([1, null, 3])
  * false
  *
- * @param null|string|\Closure $strategy
- * @param array|string|\Iterator $iterable
  * @return boolean
  */
 function all(/* [$strategy,] $iterable */)
@@ -713,7 +697,7 @@ 
 /**
  * TODO: document!
  *
- * @param array|string|\Iterator $iterable
+ * @param lib\Traits\SliceTrait $iterable
  * @param integer $start
  * @param null|integer $end
  * @return SliceIterator
@@ -734,7 +718,7 @@ 
  *
  * TODO: unit tests!
  *
- * @param array|string|\Iterator $iterable
+ * @param lib\Traits\FirstTrait $iterable
  * @param mixed $default
  * @return mixed
  */
@@ -752,7 +736,7 @@ 
  *
  * TODO: unit tests!
  *
- * @param array|string|\Iterator $iterable
+ * @param lib\Traits\LastTrait $iterable
  * @param mixed $default
  * @return mixed
  */

src/Zicht/Itertools/lib/SliceIterator.php

Doc Comments +4 added lines

@@ -60,6 +60,10 @@
     private $start;
     private $end;
 
+    /**
+     * @param integer $start
+     * @param integer $end
+     */
     public function __construct(\Iterator $iterable, $start, $end = null)
     {
         if ($start < 0 || $end < 0) {

src/Zicht/Itertools/lib/Traits/ChainTrait.php

Doc Comments -2 removed lines

@@ -26,8 +26,6 @@
      * > iter\iterable('ABC', 'DEF')->chain()
      * A B C D E F
      *
-     * @param array|string|\Iterator $iterable
-     * @param array|string|\Iterator $iterable2
      * @return iter\lib\ChainIterator
      */
     public function chain(/* $iterable, $iterable2, ... */)

src/Zicht/Itertools/lib/Traits/ReduceTrait.php

Doc Comments -1 removed lines

@@ -25,7 +25,6 @@
      * > iter\iterable([])->reduce('min', 1)
      * 1
      *
-     * @param array|string|\Iterator $iterable
      * @param string|\Closure $closure
      * @param mixed $initializer
      * @return mixed

src/Zicht/Itertools/lib/Traits/ZipTrait.php

Doc Comments -1 removed lines

@@ -22,7 +22,6 @@
      * > zip([1, 2, 3], ['a', 'b', 'c'])
      * [1, 'a'] [2, 'b'] [3, 'c']
      *
-     * @param array|string|\Iterator $iterable2
      * @return iter\lib\ZipIterator
      */
     public function zip(/* $iterable2, ... */)

src/Zicht/Itertools/reductions.php

Doc Comments +1 added lines

@@ -176,6 +176,7 @@
 
 /**
  * @deprecated please use the reduction functions directly, will be removed in version 3.0
+ * @param string $name
  */
 function getReduction($name /* [argument, [arguments, ...] */)
 {

src/Zicht/Itertools/lib/Traits/MapTrait.php

Doc Comments -1 removed lines

@@ -22,7 +22,6 @@
      * > zip([1, 2, 3], ['a', 'b', 'c'])
      * [1, 'a'] [2, 'b'] [3, 'c']
      *
-     * @param array|string|\Iterator $iterable2
      * @return iter\lib\ZipIterator
      */
     public function zip(/* $iterable2, ... */)