php-ds / polyfill

src/Sequence.php

Doc Comments +10 added lines

@@ -13,6 +13,7 @@ 
      * object as initial values.
      *
      * @param array|\Traversable|null $values
+     * @return void
      */
     function __construct($values = null);
 
@@ -22,6 +23,7 @@ 
      * @param int $capacity The number of values for which capacity should be
      *                      allocated. Capacity will stay the same if this value
      *                      is less than or equal to the current capacity.
+     * @return void
      */
     function allocate(int $capacity);
 
@@ -30,6 +32,7 @@ 
      * return value as the new value.
      *
      * @param callable $callback Accepts the value, returns the new value.
+     * @return void
      */
     function apply(callable $callback);
 
@@ -101,6 +104,7 @@ 
      * @param mixed ...$values
      *
      * @throws \OutOfRangeException if the index is not in the range [0, n]
+     * @return void
      */
     function insert(int $index, ...$values);
 
@@ -155,6 +159,7 @@ 
      * Adds zero or more values to the end of the sequence.
      *
      * @param mixed ...$values
+     * @return void
      */
     function push(...$values);
 
@@ -184,6 +189,7 @@ 
 
     /**
      * Reverses the sequence in-place.
+     * @return void
      */
     function reverse();
 
@@ -200,6 +206,7 @@ 
      * positive, or 'pop' and 'unshift' if negative.
      *
      * @param int $rotations The number of rotations (can be negative).
+     * @return void
      */
     function rotate(int $rotations);
 
@@ -210,6 +217,7 @@ 
      * @param mixed $value
      *
      * @throws \OutOfRangeException if the index is not in the range [0, size-1]
+     * @return void
      */
     function set(int $index, $value);
 
@@ -251,6 +259,7 @@ 
      *
      * @param callable|null $comparator Accepts two values to be compared.
      *                                  Should return the result of a <=> b.
+     * @return void
      */
     function sort(callable $comparator = null);
 
@@ -276,6 +285,7 @@ 
      * Adds zero or more values to the front of the sequence.
      *
      * @param mixed ...$values
+     * @return void
      */
     function unshift(...$values);
 }

src/Map.php

Doc Comments +1 added lines, -1 removed lines

@@ -112,7 +112,7 @@
      * Returns the result of associating all keys of a given traversable object
      * or array with their corresponding values, as well as those of this map.
      *
-     * @param array|\Traversable $values
+     * @param Map $values
      *
      * @return Map
      */

src/Traits/Capacity.php

Doc Comments +3 added lines, -3 removed lines

@@ -37,7 +37,7 @@ 
     }
 
     /**
-     * @return the structures growth factor.
+     * @return double structures growth factor.
      */
     protected function getGrowthFactor(): float
     {
@@ -92,7 +92,7 @@ 
     }
 
     /**
-     * @return whether capacity should be increased.
+     * @return boolean capacity should be increased.
      */
     protected function shouldDecreaseCapacity(): bool
     {
@@ -100,7 +100,7 @@ 
     }
 
     /**
-     * @return whether capacity should be increased.
+     * @return boolean capacity should be increased.
      */
     protected function shouldIncreaseCapacity(): bool
     {

Spacing +1 added lines, -1 removed lines

@@ -88,7 +88,7 @@
      */
     protected function decreaseCapacity()
     {
-        $this->capacity = max(self::MIN_CAPACITY, $this->capacity  * $this->getDecayFactor());
+        $this->capacity = max(self::MIN_CAPACITY, $this->capacity * $this->getDecayFactor());
     }
 
     /**

src/Vector.php

Doc Comments +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
     }
 
     /**
-     * @return whether capacity should be increased.
+     * @return boolean capacity should be increased.
      */
     protected function shouldIncreaseCapacity(): bool
     {