john-wilkinson / collections

src/Lists/ArrayList.php

Doc Comments +1 added lines, -1 removed lines

@@ -122,7 +122,7 @@
 	
 	/**
 	 * Returns an iterator over the elements in this list in proper sequence.
-	 * @return IteratorInterface
+	 * @return ListIterator
 	 */
 	public function iterator()
 	{

Unused Use Statements +2 added lines, -2 removed lines

@@ -1,10 +1,10 @@
 <?php
 namespace Jmw\Collection\Lists;
 
+use Jmw\Collection\CollectionAbstract;
 use Jmw\Collection\CollectionInterface;
-use Jmw\Collection\Exception\InvalidTypeException;
 use Jmw\Collection\Exception\IndexOutOfBoundsException;
-use Jmw\Collection\CollectionAbstract;
+use Jmw\Collection\Exception\InvalidTypeException;
 
 /**
  * This is the most generic collection type

src/Lists/ImmutableListTrait.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -1,8 +1,8 @@
 <?php 
 namespace Jmw\Collection\Lists;
 
-use Jmw\Collection\ImmutableCollectionTrait;
 use Jmw\Collection\Exception\UnsupportedOperationException;
+use Jmw\Collection\ImmutableCollectionTrait;
 /**
  * This trait is ensures immutability by throwing an exception
  * on all mutable ListInterface methods

src/Map/HashMap.php

Doc Comments +4 added lines, -4 removed lines

@@ -65,7 +65,7 @@ 
 	
 	/**
 	 * Returns a Set view of the mappings contained in this map.
-	 * @return SetInterface
+	 * @return TupleSet
 	*/
 	public function entrySet()
 	{
@@ -115,7 +115,7 @@ 
 	
 	/**
 	 * Returns a Set view of the keys contained in this map.
-	 * @return SetInterface
+	 * @return ArraySet
 	*/
 	public function keySet()
 	{
@@ -151,7 +151,7 @@ 
 	 * It returns the previous value associated with key,
 	 * or null if there was no mapping for key. 
 	 * (A null return can also indicate that the map previously associated null with key.)
-	 * @param unknown $key
+	 * @param string $key
 	 * @return multitype $value | null
 	*/
 	public function remove($key)
@@ -180,7 +180,7 @@ 
 	
 	/**
 	 * Returns a Collection view of the values contained in this map.
-	 * @return CollectionInterface
+	 * @return ArrayList
 	*/
 	public function values()
 	{

Unused Use Statements +1 added lines, -2 removed lines

@@ -1,10 +1,9 @@
 <?php
 namespace Jmw\Collection\Map;
 
-use Jmw\Collection\Set\SetAbstract;
 use Jmw\Collection\Lists\ArrayList;
-use Jmw\Collection\Set\TupleSet;
 use Jmw\Collection\Set\ArraySet;
+use Jmw\Collection\Set\TupleSet;
 /**
  * Hash table based implementation of the Map interface. 
  * This implementation provides all of the optional map operations, 

src/Set/ArraySet.php

Doc Comments +1 added lines, -2 removed lines

@@ -56,7 +56,7 @@ 
 	
 	/**
 	 * Returns an iterator over the elements in this collection.
-	 * @return IteratorInterface
+	 * @return SetIterator
 	 */
 	public function iterator()
 	{
@@ -65,7 +65,6 @@ 
 	
 	/**
 	 * Removes a single instance of the specified element from this collection, if it is present (optional operation).
-	 * @param boolean $changed
 	 */
 	public function remove($element)
 	{

Unused Use Statements +1 added lines, -9 removed lines

@@ -1,15 +1,7 @@
 <?php
 namespace Jmw\Collection\Set;
 
-use Jmw\Collection\Lists\Tuple;
-use Jmw\Collection\Lists\ArrayList;
-/**
- * An implementation of a Set using a php array
- * It is advisable to use a HashSet in most instances,
- * as it is faster
- * @author john
- *
- */
+
 class ArraySet extends SetAbstract
 {
 	/**

src/Set/HashSet.php

Doc Comments +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
 	
 	/**
 	 * Returns an iterator over the elements in this collection.
-	 * @return IteratorInterface
+	 * @return SetIterator
 	*/
 	public function iterator()
 	{

Unused Use Statements +1 added lines, -1 removed lines

@@ -1,8 +1,8 @@
 <?php
 namespace Jmw\Collection\Set;
 
-use Jmw\Collection\Map\HashMap;
 use Jmw\Collection\Lists\ArrayList;
+use Jmw\Collection\Map\HashMap;
 
 /**
  * This class implements the Set interface, backed by a hash table (actually a HashMap instance). 

src/Set/SetIterator.php

Doc Comments +1 added lines, -1 removed lines

@@ -82,7 +82,7 @@
 	 * The behavior of an iterator is unspecified if the underlying
 	 * collection is modified while the iteration is in progress in any
 	 * way other than by calling this method.
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public function remove()
 	{

Unused Use Statements +2 added lines, -2 removed lines

@@ -1,9 +1,9 @@
 <?php
 namespace Jmw\Collection\Set;
 
-use Jmw\Collection\IteratorInterface;
-use Jmw\Collection\Exception\NoSuchElementException;
 use Jmw\Collection\Exception\IllegalStateException;
+use Jmw\Collection\Exception\NoSuchElementException;
+use Jmw\Collection\IteratorInterface;
 
 /**
  * An iterator on a set. It uses an array to keep track

src/Set/TupleSet.php

Doc Comments +3 added lines, -4 removed lines

@@ -30,8 +30,8 @@ 
 	
 	/**
 	 * Ensures that this collection contains the specified element (optional operation).
-	 * @param multitype $element
-	 * @return boolean
+	 * @param Tuple $element
+	 * @return boolean|null
 	 */
 	public function add($element)
 	{
@@ -61,7 +61,7 @@ 
 	
 	/**
 	 * Returns an iterator over the elements in this collection.
-	 * @return IteratorInterface
+	 * @return SetIterator
 	*/
 	public function iterator()
 	{
@@ -70,7 +70,6 @@ 
 	
 	/**
 	 * Removes a single instance of the specified element from this collection, if it is present (optional operation).
-	 * @param boolean $changed
 	*/
 	public function remove($tuple)
 	{

Unused Use Statements +1 added lines, -1 removed lines

@@ -1,9 +1,9 @@
 <?php
 namespace Jmw\Collection\Set;
 
-use Jmw\Collection\Lists\Tuple;
 use Jmw\Collection\Exception\InvalidTypeException;
 use Jmw\Collection\Lists\ArrayList;
+use Jmw\Collection\Lists\Tuple;
 /**
  * A set of Tuple elements, which ensures that only Tuple elements
  * may be added to the set, and no Tuple element may be duplicated

src/Tree/SimpleTreeNode.php

Doc Comments +2 added lines, -2 removed lines

@@ -127,7 +127,7 @@ 
 	
 	/**
 	 * Adds child to the receiver at index.
-	 * @param TreeNodeInterface $nodex
+	 * @param TreeNodeInterface $node
 	 * @return void
 	*/
 	public function insert(TreeNodeInterface $node)
@@ -221,7 +221,7 @@ 
 	/**
 	 * Outputs to stdout a simplistic representation of this node and
 	 * it's children
-	 * @param number $level
+	 * @param integer $level
 	 */
 	public function printTree($level = 0)
 	{

Unused Use Statements +1 added lines, -1 removed lines

@@ -1,8 +1,8 @@
 <?php
 namespace Jmw\Collection\Tree;
 
-use Jmw\Collection\Lists\ListInterface;
 use Jmw\Collection\Lists\ArrayList;
+use Jmw\Collection\Lists\ListInterface;
 
 /**
  * Simple implementation of a tree node.