gielfeldt / iterators

src/AtomicTempFileObject.php

Doc Comments +1 added lines, -3 removed lines

@@ -133,7 +133,7 @@ 
     /**
      * Easy access iterator apply for processing an entire file.
      *
-     * @param  Iterator $input    [description]
+     * @param  \Iterator $input    [description]
      * @param  callable $callback [description]
      */
     public function process(\Iterator $input, callable $callback)
@@ -169,8 +169,6 @@ 
     /**
      * File comparison
      *
-     * @param string $filename
-     *   The file to check against.
      *
      * @return bool
      *   True if the contents of this file matches the contents of $filename.

src/GlobStreamWrapper.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
         self::$root = $root;
     }
 
+    /**
+     * @param string $path
+     */
     protected static function getRootedPath($path)
     {
         // Avoid infinite recursion.

src/SortIterator.php

Doc Comments +3 added lines

@@ -27,6 +27,9 @@
         parent::__construct($this->getSortedIterator($iterator));
     }
 
+    /**
+     * @param \Traversable $iterator
+     */
     public function getSortedIterator($iterator)
     {
         $sortedIterator = new \ArrayIterator();

src/Iterator.php

Doc Comments +3 added lines

@@ -40,6 +40,9 @@
         return $iterator->current();
     }
 
+    /**
+     * @return string
+     */
     public static function reduce(\Traversable $iterator, callable $callback, $initial = null)
     {
         $callback = \Closure::fromCallable($callback);

src/ShuffleIterator.php

Doc Comments +3 added lines

@@ -12,6 +12,9 @@
         parent::__construct($this->getShuffledIterator($iterator));
     }
 
+    /**
+     * @param \Traversable $iterator
+     */
     public function getShuffledIterator($iterator)
     {
         $sortedIterator = new \ArrayIterator();