Athari / YaLinqo

YaLinqo/EnumerableGeneration.php

Doc Comments +15 added lines, -12 removed lines

@@ -13,7 +13,7 @@ 
      * @param array|\Iterator|\IteratorAggregate|Enumerable $source Source sequence.
      * @throws \InvalidArgumentException If source is not array or Traversible or Enumerable.
      * @throws \UnexpectedValueException If source contains no elements (checked during enumeration).
-     * @return Enumerable Endless list of items repeating the source sequence.
+     * @return EnumerableGeneration Endless list of items repeating the source sequence.
      * @package YaLinqo\Generation
      */
     public static function cycle ($source)
@@ -36,7 +36,7 @@ 
     /**
      * Returns an empty sequence.
      * <p><b>Syntax</b>: emptyEnum ()
-     * @return Enumerable
+     * @return EnumerableGeneration
      * @package YaLinqo\Generation
      */
     public static function emptyEnum ()
@@ -79,6 +79,9 @@ 
         throw new \InvalidArgumentException('source must be array or Traversable.');
     }
 
+    /**
+     * @param \Traversable $source
+     */
     private static function fromTraversable ($source)
     {
         foreach ($source as $k => $v)
@@ -93,7 +96,7 @@ 
      * @param mixed $seedValue Initial state of the generator loop for values. Default: null.
      * @param callable|null $funcKey {(v, k) ==> key} State update function to run on key after every iteration of the generator loop. Default: increment.
      * @param mixed $seedKey Initial state of the generator loop ofr keys. Default: 0.
-     * @return Enumerable
+     * @return EnumerableGeneration
      * @package YaLinqo\Generation
      */
     public static function generate ($funcValue, $seedValue = null, $funcKey = null, $seedKey = null)
@@ -120,7 +123,7 @@ 
      * <p><b>Syntax</b>: toInfinity ([start [, step]])
      * @param int $start The first integer in the sequence. Default: 0.
      * @param int $step The difference between adjacent integers. Default: 1.
-     * @return Enumerable
+     * @return EnumerableGeneration
      * @package YaLinqo\Generation
      */
     public static function toInfinity ($start = 0, $step = 1)
@@ -138,7 +141,7 @@ 
      * @param string $subject The input string.
      * @param string $pattern The pattern to search for, as a string.
      * @param int $flags Can be a combination of the following flags: PREG_PATTERN_ORDER, PREG_SET_ORDER, PREG_OFFSET_CAPTURE. Default: PREG_SET_ORDER.
-     * @return Enumerable
+     * @return EnumerableGeneration
      * @see preg_match_all
      * @package YaLinqo\Generation
      */
@@ -155,7 +158,7 @@ 
      * <p><b>Syntax</b>: toNegativeInfinity ([start [, step]])
      * @param int $start The first integer in the sequence. Default: 0.
      * @param int $step The difference between adjacent integers. Default: 1.
-     * @return Enumerable
+     * @return EnumerableGeneration
      * @package YaLinqo\Generation
      */
     public static function toNegativeInfinity ($start = 0, $step = 1)
@@ -167,7 +170,7 @@ 
      * Returns a sequence that contains a single element with a specified value.
      * <p><b>Syntax</b>: returnEnum (element)
      * @param mixed $element The single element in the resulting sequence.
-     * @return Enumerable Observable sequence containing the single specified element.
+     * @return EnumerableGeneration Observable sequence containing the single specified element.
      * @package YaLinqo\Generation
      */
     public static function returnEnum ($element)
@@ -183,7 +186,7 @@ 
      * @param int $start The value of the first integer in the sequence.
      * @param int $count The number of integers to generate.
      * @param int $step The difference between adjacent integers. Default: 1.
-     * @return Enumerable A sequence that contains a range of integral numbers.
+     * @return EnumerableGeneration A sequence that contains a range of integral numbers.
      * @package YaLinqo\Generation
      */
     public static function range ($start, $count, $step = 1)
@@ -205,7 +208,7 @@ 
      * @param int $start The value of the first integer in the sequence.
      * @param int $count The number of integers to generate.
      * @param int $step The difference between adjacent integers. Default: 1.
-     * @return Enumerable A sequence that contains a range of integral numbers.
+     * @return EnumerableGeneration A sequence that contains a range of integral numbers.
      * @package YaLinqo\Generation
      */
     public static function rangeDown ($start, $count, $step = 1)
@@ -222,7 +225,7 @@ 
      * @param int $end The value of the last integer in the sequence (not included).
      * @param int $step The difference between adjacent integers. Default: 1.
      * @throws \InvalidArgumentException If step is not a positive number.
-     * @return Enumerable A sequence that contains a range of integral numbers.
+     * @return EnumerableGeneration A sequence that contains a range of integral numbers.
      * @package YaLinqo\Generation
      */
     public static function rangeTo ($start, $end, $step = 1)
@@ -251,7 +254,7 @@ 
      * @param int $element The value to be repeated.
      * @param int $count The number of times to repeat the value in the generated sequence. Default: null.
      * @throws \InvalidArgumentException If count is less than 0.
-     * @return Enumerable A sequence that contains a repeated value.
+     * @return EnumerableGeneration A sequence that contains a repeated value.
      * @package YaLinqo\Generation
      */
     public static function repeat ($element, $count = null)
@@ -270,7 +273,7 @@ 
      * @param string $subject The input string.
      * @param string $pattern The pattern to search for, as a string.
      * @param int $flags flags can be any combination of the following flags: PREG_SPLIT_NO_EMPTY, PREG_SPLIT_DELIM_CAPTURE, PREG_SPLIT_OFFSET_CAPTURE. Default: 0.
-     * @return Enumerable
+     * @return EnumerableGeneration
      * @see preg_split
      * @package YaLinqo\Generation
      */