hiqdev / hidev

src/handlers/CommitsHandler.php

Doc Comments +16 added lines

@@ -59,6 +59,9 @@ 
         $this->_hash = $hash;
     }
 
+    /**
+     * @param string $label
+     */
     public function addTag($tag, $label = null)
     {
         $this->tag = $tag;
@@ -66,6 +69,9 @@ 
         $ref       = $label ?: $ref ?: $tag;
     }
 
+    /**
+     * @param string $note
+     */
     public function addNote($note, $label = null)
     {
         $this->note = $note;
@@ -73,6 +79,10 @@ 
         $ref        = $label ?: $ref ?: $note;
     }
 
+    /**
+     * @param string $hash
+     * @param string $label
+     */
     public function addHash($hash, $label)
     {
         $this->_hash                    = $hash;
@@ -183,6 +193,9 @@ 
         return $res;
     }
 
+    /**
+     * @param string $key
+     */
     public static function arrayPop(&$array, $key)
     {
         $res = $array[$key];
@@ -239,6 +252,9 @@ 
         return $date ? date(' Y-m-d', strtotime($date)) : '';
     }
 
+    /**
+     * @param string $string
+     */
     public static function renderHeader($string)
     {
         $header = Yii::$app->config->package->fullName . ' ' . $string;

src/components/Config.php

Doc Comments +3 added lines

@@ -72,6 +72,9 @@
         return false;
     }
 
+    /**
+     * @param string $id
+     */
     public function getGoal($id)
     {
         return Yii::$app->createControllerById($id);

src/base/Application.php

Doc Comments +3 added lines, -1 removed lines

@@ -69,7 +69,6 @@ 
 
     /**
      * Load extra config files.
-     * @param array $config
      * @return void
      */
     public function loadExtraVendor($dir)
@@ -134,6 +133,9 @@ 
         return $controller;
     }
 
+    /**
+     * @param string $string
+     */
     public function runRequest($string)
     {
         $request = Yii::createObject([

src/base/File.php

Doc Comments +12 added lines

@@ -122,6 +122,9 @@ 
         return $type2extension[$type];
     }
 
+    /**
+     * @param string $extension
+     */
     public function getTypeByExtension($extension)
     {
         return static::$_extension2type[$extension];
@@ -132,6 +135,9 @@ 
         return ($this->goal ? $this->goal->fileType : null) ?: static::getTypeByExtension($this->_extension) ?: 'template';
     }
 
+    /**
+     * @param string $path
+     */
     public function setPath($path)
     {
         $path             = Yii::getAlias($path);
@@ -208,6 +214,9 @@ 
         return $this->handler->renderPath($this->path, $this->data);
     }
 
+    /**
+     * @param string $content
+     */
     public function write($content)
     {
         return $this->handler->write($this->path, $content);
@@ -218,6 +227,9 @@ 
         return $this->data = $this->handler->parsePath($this->path, $this->minimalPath);
     }
 
+    /**
+     * @return string
+     */
     public function read()
     {
         return $this->handler->read($this->path);

src/controllers/GithubController.php

Doc Comments +5 added lines, -1 removed lines

@@ -113,7 +113,7 @@ 
     /**
      * Action to check if repo exists.
      * @param string $repo full name vendor/package defaults to this repo name
-     * @return int exit code
+     * @return boolean exit code
      */
     public function actionExists($repo = null)
     {
@@ -160,6 +160,10 @@ 
         return 0;
     }
 
+    /**
+     * @param string $method
+     * @param string $path
+     */
     public function request($method, $path, $data)
     {
         $url = 'https://api.github.com' . $path;

src/handlers/BaseHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
      *
      * @param mixed $data
      *
-     * @return string file content
+     * @return boolean file content
      */
     public function renderPath($path, $data)
     {
@@ -156,7 +156,7 @@ 
      * Read file into a string or array.
      * @param string $path
      * @param bool $asArray
-     * @return string|array
+     * @return string
      */
     public function read($path, $asArray = false)
     {

src/controllers/AbstractController.php

Doc Comments +10 added lines, -4 removed lines

@@ -48,7 +48,7 @@ 
     }
 
     /**
-     * @return int|Response exit code
+     * @return null|integer exit code
      */
     public function actionMake()
     {
@@ -142,7 +142,7 @@ 
     /**
      * Is response NOT Ok.
      * @param Response|int $res
-     * @return bool
+     * @return integer
      */
     public static function isNotOk($res)
     {
@@ -151,7 +151,7 @@ 
 
     /**
      * Is response Ok.
-     * @param Response|int $res
+     * @param integer $res
      * @return bool
      */
     public static function isOk($res)
@@ -163,7 +163,7 @@ 
      * Runs list of actions.
      * TODO: think to redo with runRequests.
      * @param null|string|array $actions
-     * @return int|Response exit code
+     * @return null|integer exit code
      */
     public function runActions($actions)
     {
@@ -240,6 +240,9 @@ 
         return readline($prompt);
     }
 
+    /**
+     * @param string $prompt
+     */
     public function readpassword($prompt)
     {
         echo $prompt;
@@ -250,6 +253,9 @@ 
         return $password;
     }
 
+    /**
+     * @param string $id
+     */
     public static function takeGoal($id)
     {
         return Yii::$app->get('config')->getGoal($id);

src/helpers/Helper.php

Doc Comments +12 added lines

@@ -19,11 +19,17 @@ 
  */
 class Helper
 {
+    /**
+     * @return string
+     */
     public static function bad2sep($str, $separator = '-')
     {
         return preg_replace('/[^a-zA-Z0-9-]/', $separator, $str);
     }
 
+    /**
+     * @param string $id
+     */
     public static function id2camel($id, $separator = '-')
     {
         return Inflector::id2camel(self::bad2sep($id, $separator), $separator);
@@ -35,6 +41,9 @@ 
         return str_replace('--', '-', Inflector::camel2id(str_replace(' ', '', ucwords($name)), $separator, $strict));
     }
 
+    /**
+     * @param string $file
+     */
     public static function file2template($file, $separator = '-')
     {
         return trim($file, '.');
@@ -70,6 +79,9 @@ 
         return array_combine($res, $res);
     }
 
+    /**
+     * @param string $subj
+     */
     public static function getPublicVars($subj)
     {
         return is_object($subj) ? get_object_vars($subj) : get_class_vars($subj);