Fixed the documentation.

This is needed in preparation for the PhpStorm stub (php-ds/ext-ds#128).

Author: hopeseekr

src/Hashable.php

@@ -26,7 +26,7 @@ function hash();
      * Determines if two objects should be considered equal. Both objects will
      * be instances of the same class but may not be the same instance.
      *
-     * @param $obj An instance of the same class to compare to.
+     * @param $obj self An instance of the same class to compare to.
      *
      * @return bool
      */

src/Map.php

@@ -393,6 +393,10 @@ public function reduce(callable $callback, $initial = null)
     /**
      * Completely removes a pair from the internal array by position. It is
      * important to remove it from the array and not just use 'unset'.
+     *
+     * @param int $position
+     *
+     * @return mixed
      */
     private function delete(int $position)
     {
@@ -434,9 +438,7 @@ public function remove($key, $default = null)
     }
 
     /**
-     * Returns a reversed copy of the map.
-     *
-     * @return Map
+     * Sorts the map into the reversed order.
      */
     public function reverse()
     {

src/Pair.php

@@ -88,8 +88,10 @@ public function jsonSerialize()
 
     /**
      * Returns a string representation of the pair.
+     *
+     * @return string a string representation of the pair.
      */
-    public function __toString()
+    public function __toString(): string
     {
         return 'object(' . get_class($this) . ')';
     }

src/PriorityQueue.php

@@ -50,7 +50,7 @@ public function clear()
     /**
      * @inheritDoc
      */
-    public function copy(): \Ds\Collection
+    public function copy(): Collection
     {
         $copy = new PriorityQueue();
 

src/Queue.php

@@ -65,7 +65,7 @@ public function clear()
     /**
      * @inheritDoc
      */
-    public function copy(): \Ds\Collection
+    public function copy(): Collection
     {
         return new self($this->deque);
     }
@@ -81,7 +81,7 @@ public function count(): int
     /**
      * Returns the value at the front of the queue without removing it.
      *
-     * @return
+     * @return mixed
      */
     public function peek()
     {

src/Set.php

@@ -101,7 +101,7 @@ public function contains(...$values): bool
     /**
      * @inheritDoc
      */
-    public function copy(): \Ds\Collection
+    public function copy(): Collection
     {
         return new self($this);
     }

src/Traits/Capacity.php

@@ -37,7 +37,7 @@ public function allocate(int $capacity)
     }
 
     /**
-     * @return the structures growth factor.
+     * @return float the structures growth factor.
      */
     protected function getGrowthFactor(): float
     {
@@ -92,15 +92,15 @@ protected function decreaseCapacity()
     }
 
     /**
-     * @return whether capacity should be increased.
+     * @return bool whether capacity should be increased.
      */
     protected function shouldDecreaseCapacity(): bool
     {
         return count($this) <= $this->capacity * $this->getTruncateThreshold();
     }
 
     /**
-     * @return whether capacity should be increased.
+     * @return bool whether capacity should be increased.
      */
     protected function shouldIncreaseCapacity(): bool
     {

src/Traits/GenericCollection.php

@@ -25,7 +25,7 @@ public function isEmpty(): bool
      * Returns a representation that can be natively converted to JSON, which is
      * called when invoking json_encode.
      *
-     * @return mixed
+     * @return mixed the data to be JSON encoded.
      *
      * @see JsonSerializable
      */
@@ -60,16 +60,18 @@ abstract public function toArray(): array;
      *
      * @return array
      */
-    public function __debugInfo()
+    public function __debugInfo(): array
     {
         return $this->toArray();
     }
 
     /**
      * Returns a string representation of the collection, which is invoked when
      * the collection is converted to a string.
+     *
+     * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         return 'object(' . get_class($this) . ')';
     }

src/Traits/GenericSequence.php

@@ -236,6 +236,10 @@ public function reversed(): Sequence
     /**
      * Converts negative or large rotations into the minimum positive number
      * of rotations required to rotate the sequence by a given $r.
+     *
+     * @param int $r
+     *
+     * @return int
      */
     private function normalizeRotations(int $r)
     {

src/Vector.php

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