SiroDiaz / DataStructures

DataStructures/Trees/BinarySearchTree.php

Doc Comments +13 added lines, -12 removed lines

@@ -84,8 +84,8 @@ 
     /**
      * Creates a new node or updates it if already exists.
      *
-     * @param int|string $key the key.
-     * @param mixed $data the data to be stored. 
+     * @param integer $key the key.
+     * @param string $data the data to be stored. 
      */
     public function putOrUpdate($key, $data) {
         $this->put($key, $data, true);
@@ -94,7 +94,7 @@ 
     /**
      * Retrieve the data stored in the tree.
      *
-     * @param int|string $key the key to identify the data.
+     * @param integer $key the key to identify the data.
      * @return mixed
      */
     public function get($key) {
@@ -132,7 +132,7 @@ 
     /**
      * Looks for the node with the given key.
      *
-     * @param int|string $key the key used to look for.
+     * @param string $key the key used to look for.
      * @return bool true if was found.
      */
     public function exists($key) : bool {
@@ -196,7 +196,7 @@ 
     /**
      * Returns the minimum node from a given node in position X.
      *
-     * @param DataStructures\Trees\Nodes\BSTNode $node the start point.
+     * @param Node $node the start point.
      * @return DataStructures\Trees\Nodes\BSTNode|null the minimum node.
      */
     private function getMinNode(Node $node = null) {
@@ -237,7 +237,7 @@ 
     /**
      * Returns the maximum node from a given node in position X.
      *
-     * @param DataStructures\Trees\Nodes\BSTNode $node the start point.
+     * @param Node $node the start point.
      * @return DataStructures\Trees\Nodes\BSTNode|null the maximum node.
      */
     private function getMaxNode(Node $node = null) {
@@ -256,7 +256,7 @@ 
      * Deletes the node with the minimum key and returns it. The most left and more bottom.
      * 
      * @param DataStructures\Trees\Nodes\BSTNode|null if null takes the root.
-     * @return DataStructures\Trees\Nodes\BSTNode|null the minimum node or
+     * @return Node|null the minimum node or
      *  null if the tree is empty.
      */
     public function deleteMin(Node $node = null) {
@@ -272,7 +272,7 @@ 
      * Deletes the node with the maximum key and returns it. The most right and more bottom.
      * 
      * @param DataStructures\Trees\Nodes\BSTNode|null if null takes the root.
-     * @return DataStructures\Trees\Nodes\BSTNode|null the maximum node or
+     * @return Node|null the maximum node or
      *  null if the tree is empty.
      */
     public function deleteMax(Node $node = null) {
@@ -288,7 +288,8 @@ 
      * Deletes the node with the maximum key and returns it. The most right and more bottom.
      * 
      * @param DataStructures\Trees\Nodes\BSTNode|null if null takes the root.
-     * @return DataStructures\Trees\Nodes\BSTNode|null the maximum node or
+     * @param integer $key
+     * @return Node|null the maximum node or
      *  null if the tree is empty.
      */
     public function delete($key) {
@@ -331,7 +332,7 @@ 
      * that replaces the deleted node. Also decrease the size of tree.
      *
      * @param DataStructures\Trees\Nodes\BSTNode|null The node to be deleted.
-     * @return the node that replaces the deleted.
+     * @return DataStructures\Trees\Nodes\BSTNode|null node that replaces the deleted.
      */
     private function _delete(Node &$node) {
         if($node !== null) {
@@ -394,7 +395,7 @@ 
      * Returns true if is leaf the node.
      *
      * @param DataStructures\Trees\Nodes\BSTNode|null $node default to null.
-     * @return true if is leaf the node, is not null and their subtrees has no
+     * @return boolean if is leaf the node, is not null and their subtrees has no
      *  pointers to successors.
      */
     public function isLeaf($node) {
@@ -406,7 +407,7 @@ 
      * also are called a root node.
      *
      * @param DataStructures\Trees\Nodes\BSTNode|null $node default to null.
-     * @return true if is root the node, is not null and their subtrees has no
+     * @return boolean if is root the node, is not null and their subtrees has no
      *  pointers to successors.
      */
     public function isRoot($node) {