some doc comment improvements (closes #10)

Author: schmittjoh

src/PhpCollection/AbstractMap.php

@@ -24,9 +24,6 @@
 /**
  * A simple map implementation which basically wraps an array with an object oriented interface.
  *
- * @IgnoreAnnotation("template")
- * @template {K extends string} This implementation only supports strings as keys.
- *
  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  */
 class AbstractMap extends AbstractCollection implements \IteratorAggregate, MapInterface
@@ -57,7 +54,7 @@ public function exists($callable)
     /**
      * Sets all key/value pairs in the map.
      *
-     * @param array<string,T> $kvMap
+     * @param array $kvMap
      *
      * @return void
      */

src/PhpCollection/AbstractSequence.php

@@ -31,17 +31,14 @@
  *
  * This sequence is mutable.
  *
- * @IgnoreAnnotation("template")
- * @template T The type that this sequence contains.
- *
  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  */
 class AbstractSequence extends AbstractCollection implements \IteratorAggregate, SequenceInterface
 {
     protected $elements;
 
     /**
-     * @param array<T> $elements
+     * @param array $elements
      */
     public function __construct(array $elements = array())
     {
@@ -289,7 +286,7 @@ public function take($number)
      *
      * @param callable $callable receives elements of this sequence as first argument, and returns true/false.
      *
-     * @return Sequence<T>
+     * @return Sequence
      */
     public function takeWhile($callable)
     {

src/PhpCollection/MapInterface.php

@@ -23,25 +23,21 @@
 /**
  * Basic map interface.
  *
- * @IgnoreAnnotation("template")
- * @template K the type of the keys
- * @template V the type of the values
- *
  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  */
 interface MapInterface extends CollectionInterface
 {
     /**
      * Returns the first element in the collection if available.
      *
-     * @return Option<array<K,V>>
+     * @return Option on array<K,V>
      */
     public function first();
 
     /**
      * Returns the last element in the collection if available.
      *
-     * @return Option<array<K,V>>
+     * @return Option on array<K,V>
      */
     public function last();
 
@@ -50,23 +46,23 @@ public function last();
      *
      * @param callable $callable receives the element as first argument, and returns true, or false
      *
-     * @return Option<array<K,V>>
+     * @return Option on array<K,V>
      */
     public function find($callable);
 
     /**
      * Returns the value associated with the given key.
      *
-     * @param K $key
+     * @param mixed $key
      *
-     * @return Option<V>
+     * @return Option on V
      */
     public function get($key);
 
     /**
      * Returns whether this map contains a given key.
      *
-     * @param K $key
+     * @param mixed $key
      *
      * @return boolean
      */
@@ -75,8 +71,8 @@ public function containsKey($key);
     /**
      * Puts a new element in the map.
      *
-     * @param K $key
-     * @param V $value
+     * @param mixed $key
+     * @param mixed $value
      *
      * @return void
      */
@@ -85,32 +81,32 @@ public function set($key, $value);
     /**
      * Removes an element from the map.
      *
-     * @param K $key
+     * @param mixed $key
      *
-     * @return V
+     * @return mixed
      */
     public function remove($key);
 
     /**
      * Adds all another map to this map, and returns itself.
      *
-     * @param MapInterface<K,V> $map
+     * @param MapInterface $map
      *
-     * @return MapInterface<K,V>
+     * @return MapInterface
      */
     public function addMap(MapInterface $map);
 
     /**
      * Returns an array with the keys.
      *
-     * @return array<K>
+     * @return array
      */
     public function keys();
 
     /**
      * Returns an array with the values.
      *
-     * @return array<V>
+     * @return array
      */
     public function values();
 
@@ -121,7 +117,7 @@ public function values();
      *
      * @param integer $number
      *
-     * @return MapInterface<K,V>
+     * @return MapInterface
      */
     public function drop($number);
 
@@ -132,7 +128,7 @@ public function drop($number);
      *
      * @param integer $number
      *
-     * @return MapInterface<K,V>
+     * @return MapInterface
      */
     public function dropRight($number);
 
@@ -141,7 +137,7 @@ public function dropRight($number);
      *
      * @param callable $callable Receives the element to drop as first argument, and returns true (drop), or false (stop).
      *
-     * @return MapInterface<K,V>
+     * @return MapInterface
      */
     public function dropWhile($callable);
 
@@ -154,7 +150,7 @@ public function dropWhile($callable);
      *
      * @param integer $number
      *
-     * @return MapInterface<K,V>
+     * @return MapInterface
      */
     public function take($number);
 
@@ -164,7 +160,7 @@ public function take($number);
      *
      * @param callable $callable
      *
-     * @return MapInterface<K,V>
+     * @return MapInterface
      */
     public function takeWhile($callable);
 }

src/PhpCollection/SequenceInterface.php

@@ -32,37 +32,37 @@ interface SequenceInterface extends CollectionInterface
     /**
      * Returns the first element in the collection if available.
      *
-     * @return Option<T>
+     * @return Option
      */
     public function first();
 
     /**
      * Returns the last element in the collection if available.
      *
-     * @return Option<T>
+     * @return Option
      */
     public function last();
 
     /**
      * Returns all elements in this sequence.
      *
-     * @return array<T>
+     * @return array
      */
     public function all();
 
     /**
      * Adds the elements of another sequence to this sequence.
      *
-     * @param SequenceInterface<T> $seq
+     * @param SequenceInterface $seq
      *
-     * @return SequenceInterface<T>
+     * @return SequenceInterface
      */
     public function addSequence(SequenceInterface $seq);
 
     /**
      * Returns the index of the passed element.
      *
-     * @param T $elem
+     * @param mixed $elem
      *
      * @return integer the index (0-based), or -1 if not found
      */
@@ -71,7 +71,7 @@ public function indexOf($elem);
     /**
      * Returns the last index of the passed element.
      *
-     * @param T $elem
+     * @param mixed $elem
      * @return integer the index (0-based), or -1 if not found
      */
     public function lastIndexOf($elem);
@@ -105,7 +105,7 @@ public function lastIndexWhere($callable);
     /**
      * Returns all indices of this collection.
      *
-     * @return array<integer>
+     * @return integer[]
      */
     public function indices();
 
@@ -114,14 +114,14 @@ public function indices();
      *
      * @param integer $index (0-based)
      *
-     * @return T
+     * @return mixed
      */
     public function get($index);
 
     /**
      * Adds an element to the sequence.
      *
-     * @param T $elem
+     * @param mixed $elem
      *
      * @return void
      */
@@ -132,14 +132,14 @@ public function add($elem);
      *
      * @param integer $index
      *
-     * @return T
+     * @return mixed
      */
     public function remove($index);
 
     /**
      * Adds all elements to the sequence.
      *
-     * @param array<T> $elements
+     * @param array $elements
      *
      * @return void
      */
@@ -149,7 +149,7 @@ public function addAll(array $elements);
      * Updates the value at the given index.
      *
      * @param integer $index
-     * @param T $value
+     * @param mixed $value
      *
      * @return void
      */
@@ -195,7 +195,7 @@ public function dropWhile($callable);
      *
      * @param integer $number
      *
-     * @return CollectionInterface<T>
+     * @return CollectionInterface
      */
     public function take($number);
 
@@ -205,7 +205,7 @@ public function take($number);
      *
      * @param callable $callable
      *
-     * @return CollectionInterface<T>
+     * @return CollectionInterface
      */
     public function takeWhile($callable);