hiqdev / hidev

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/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/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);

src/base/File.php

Doc Comments +12 added lines

@@ -143,6 +143,9 @@ 
         return $type2extension[$type];
     }
 
+    /**
+     * @param string $extension
+     */
     public function getTypeByExtension($extension)
     {
         return isset(static::$_extension2type[$extension]) ? static::$_extension2type[$extension] : null;
@@ -157,6 +160,9 @@ 
         return ($this->goal ? $this->goal->fileType : null) ?: static::getTypeByExtension($this->_extension) ?: 'template';
     }
 
+    /**
+     * @param string $path
+     */
     public function setPath($path)
     {
         $path             = Yii::getAlias($path);
@@ -233,6 +239,9 @@ 
         return $this->getHandler()->renderPath($this->getPath(), $this->data);
     }
 
+    /**
+     * @param string $content
+     */
     public function write($content)
     {
         return $this->getHandler()->write($this->getPath(), $content);
@@ -243,6 +252,9 @@ 
         return $this->data = $this->getHandler()->parsePath($this->getPath(), $this->getMinimalPath());
     }
 
+    /**
+     * @return string
+     */
     public function read()
     {
         return $this->getHandler()->read($this->getPath());

src/controllers/AbstractController.php

Doc Comments +10 added lines, -4 removed lines

@@ -47,7 +47,7 @@ 
     }
 
     /**
-     * @return int|Response exit code
+     * @return null|integer exit code
      */
     public function actionMake()
     {
@@ -141,7 +141,7 @@ 
     /**
      * Is response NOT Ok.
      * @param Response|int $res
-     * @return bool
+     * @return integer
      */
     public static function isNotOk($res)
     {
@@ -150,7 +150,7 @@ 
 
     /**
      * Is response Ok.
-     * @param Response|int $res
+     * @param integer $res
      * @return bool
      */
     public static function isOk($res)
@@ -162,7 +162,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)
     {
@@ -244,6 +244,9 @@ 
         return readline($prompt);
     }
 
+    /**
+     * @param string $prompt
+     */
     public function readpassword($prompt)
     {
         echo $prompt;
@@ -255,6 +258,9 @@ 
         return $password;
     }
 
+    /**
+     * @param string $id
+     */
     public function takeGoal($id)
     {
         return $this->module->get('config')->getGoal($id);

src/base/Application.php

Doc Comments +6 added lines, -3 removed lines

@@ -91,6 +91,10 @@ 
         $this->setExtraConfig(static::readVendorConfig($vendor, 'hidev'));
     }
 
+    /**
+     * @param string $vendor
+     * @param string $name
+     */
     public function readVendorConfig($vendor, $name)
     {
         return static::readConfig(ConfigPlugin::path($vendor, $name));
@@ -98,7 +102,6 @@ 
 
     /**
      * Sets extra environment variables.
-     * @param array $config
      */
     public function setExtraEnv($vars)
     {
@@ -199,8 +202,8 @@ 
 
     /**
      * Run request.
-     * @param string|array $query
-     * @return Response
+     * @param string $query
+     * @return \yii\console\Response
      */
     public function runRequest($query)
     {