Improve documentation

Author: clue

src/Tree/Base.php

@@ -29,6 +29,7 @@
  * Tree\BaseDirected.
  *
  * @link http://en.wikipedia.org/wiki/Tree_%28graph_theory%29
+ * @link http://en.wikipedia.org/wiki/Tree_%28data_structure%29
  * @see Undirected for an implementation of these algorithms on (undirected) trees
  * @see BaseDirected for an abstract implementation of these algorithms on directed, rooted trees
  */

src/Tree/BaseDirected.php

@@ -72,7 +72,7 @@ public function getVertexRoot()
      * checks if this is a tree
      *
      * @return boolean
-     * @uses Graph::isEmpty() to skip empty Graphs (an empty is Graph is a valid tree)
+     * @uses Graph::isEmpty() to skip empty Graphs (an empty Graph is a valid tree)
      * @uses self::getVertexRoot() to get root Vertex to start search from
      * @uses self::getVerticesSubtree() to count number of vertices connected to root
      */
@@ -130,7 +130,7 @@ public function getVertexParent(Vertex $vertex)
      *
      * @param Vertex $vertex
      * @return Vertex[]
-     * @throws UnexpectedValueException if the given $vertex contains invalid / parallel links (check isTree()!)
+     * @throws UnexpectedValueException if the given $vertex contains invalid / parallel edges (check isTree()!)
      */
     abstract public function getVerticesChildren(Vertex $vertex);
 
@@ -142,6 +142,7 @@ abstract public function getVerticesChildren(Vertex $vertex);
      *
      * @param Vertex $vertex
      * @return Vertex[]
+     * @throws UnexpectedValueException if the given $vertex contains invalid / parallel edges (check isTree()!)
      */
     abstract protected function getVerticesParent(Vertex $vertex);
 

src/Tree/Undirected.php

@@ -102,7 +102,7 @@ public function isVertexInternal(Vertex $vertex)
      * @param Vertex[]    $vertices
      * @param Vertex|null $ignore
      * @throws UnexpectedValueException for cycles or directed edges (check isTree()!)
-     * @uses self::getVerticesNeighboor()
+     * @uses self::getVerticesNeighbor()
      * @uses self::getVerticesSubtreeRecursive() to recurse into sub-subtrees
      */
     private function getVerticesSubtreeRecursive(Vertex $vertex, &$vertices, Vertex $ignore = null)
@@ -113,7 +113,7 @@ private function getVerticesSubtreeRecursive(Vertex $vertex, &$vertices, Vertex
         }
         $vertices[$vertex->getId()] = $vertex;
 
-        foreach ($this->getVerticesNeighboor($vertex) as $vertexNeighboor) {
+        foreach ($this->getVerticesNeighbor($vertex) as $vertexNeighboor) {
             if ($vertexNeighboor === $ignore) {
                 // ignore source vertex only once
                 $ignore = null;
@@ -124,7 +124,7 @@ private function getVerticesSubtreeRecursive(Vertex $vertex, &$vertices, Vertex
     }
 
     /**
-     * get neighboor vertices for given start vertex
+     * get neighbor vertices for given start vertex
      *
      * @param Vertex $vertex
      * @throws UnexpectedValueException for directed edges
@@ -133,7 +133,7 @@ private function getVerticesSubtreeRecursive(Vertex $vertex, &$vertices, Vertex
      * @uses Edge::getVertexToFrom()
      * @see Vertex::getVerticesEdge()
      */
-    private function getVerticesNeighboor(Vertex $vertex)
+    private function getVerticesNeighbor(Vertex $vertex)
     {
         $vertices = array();
         foreach ($vertex->getEdges() as $edge) {