hiqdev / chkipper

src/history/Builder.php

Doc Comments +21 added lines

@@ -69,34 +69,55 @@
         return $this->_hash;
     }
 
+    /**
+     * @param string $header
+     */
     public function addHeader($header)
     {
         $this->getHistory()->addHeader($header);
     }
 
+    /**
+     * @param string $tag
+     * @param string $date
+     */
     public function addTag($tag, $date = null)
     {
         $this->setTag($tag);
         $this->getHistory()->addTag($tag, $date);
     }
 
+    /**
+     * @param string $note
+     */
     public function addNote($note)
     {
         $this->setNote($note);
         $this->getHistory()->addNote($this->getTag(), $note, $label);
     }
 
+    /**
+     * @param string $hash
+     * @param string $label
+     */
     public function addCommit($hash, $label)
     {
         $this->setHash($hash);
         $this->getHistory()->addCommit($this->getTag(), $this->getNote(), $hash, $label);
     }
 
+    /**
+     * @param string $comment
+     */
     public function addComment($comment)
     {
         $this->getHistory()->addComment($this->getTag(), $this->getNote(), $this->getHash(), $comment);
     }
 
+    /**
+     * @param string $link
+     * @param string $href
+     */
     public function addLink($link, $href)
     {
         $this->getHistory()->addLink($link, $href);

src/history/History.php

Doc Comments +18 added lines

@@ -76,6 +76,9 @@ 
         $this->findTag($tag)->setDate($date);
     }
 
+    /**
+     * @param string $tag
+     */
     public function addNote($tag, $note)
     {
         $this->findTag($tag)->findNote($note);
@@ -91,12 +94,21 @@ 
         $this->_hashes[(string) $hash] = $label;
     }
 
+    /**
+     * @param string $tag
+     * @param string $note
+     */
     public function addCommit($tag, $note, $hash, $label = null)
     {
         $this->addHash($hash, $label);
         $this->findTag($tag)->findNote($note)->findCommit($hash)->setLabel($label);
     }
 
+    /**
+     * @param string $tag
+     * @param string $note
+     * @param string $hash
+     */
     public function addComment($tag, $note, $hash, $text = null)
     {
         $this->findTag($tag)->findNote($note)->findCommit($hash)->addComment($text);
@@ -159,6 +171,9 @@ 
         return $res;
     }
 
+    /**
+     * @param string $key
+     */
     public static function arrayPop(&$array, $key)
     {
         $res = $array[$key];
@@ -224,6 +239,9 @@ 
         return $date ? date(' Y-m-d', strtotime($date)) : '';
     }
 
+    /**
+     * @param string $string
+     */
     public static function renderHeader($string)
     {
         $res = '';

Unused Use Statements -2 removed lines

@@ -2,8 +2,6 @@
 
 namespace hiqdev\chkipper\history;
 
-use Yii;
-
 /**
  * History class.
  * Holds history of commits.

src/history/Parser.php

Doc Comments +3 added lines

@@ -4,6 +4,9 @@
 
 class Parser extends Builder
 {
+    /**
+     * @param string $path
+     */
     public function parsePath($path, $minimal = null)
     {
         $this->addTag($this->getLastTag());

src/history/Renderer.php

Doc Comments +6 added lines

@@ -11,6 +11,9 @@ 
 {
     public $indent = '    ';
 
+    /**
+     * @param History $value
+     */
     public function setHistory($value)
     {
         $this->_history = $value;
@@ -46,6 +49,9 @@ 
         return $this->renderObjects('renderLink', $this->getHistory()->getLinks());
     }
 
+    /**
+     * @param string $method
+     */
     public function renderObjects($method, $objects)
     {
         $res = [];