rob006 / yii2-dev

build/controllers/PhpDocController.php

Doc Comments +24 added lines, -2 removed lines

@@ -114,6 +114,9 @@ 
         return array_merge(parent::options($actionID), ['updateFiles', 'skipFrameworkRequirements']);
     }
 
+    /**
+     * @param string|null $root
+     */
     protected function findFiles($root, $needsInclude = true)
     {
         $except = [];
@@ -237,6 +240,9 @@ 
         return FileHelper::findFiles($root, $options);
     }
 
+    /**
+     * @param string $extensionPath
+     */
     private function setUpExtensionAliases($extensionPath)
     {
         foreach (scandir($extensionPath) as $extension) {
@@ -344,6 +350,9 @@ 
         }
     }
 
+    /**
+     * @param string $line
+     */
     protected function fixParamTypes($line)
     {
         return preg_replace_callback('~@(param|return) ([\w\\|]+)~i', function($matches) {
@@ -477,6 +486,10 @@ 
         // TODO
     }
 
+    /**
+     * @param null|string $className
+     * @param string $propertyDoc
+     */
     protected function updateClassPropertyDocs($file, $className, $propertyDoc)
     {
         $ref = new \ReflectionClass($className);
@@ -552,7 +565,7 @@ 
     /**
      * remove multi empty lines and trim trailing whitespace
      *
-     * @param $doc
+     * @param string $doc
      * @return string
      */
     protected function cleanDocComment($doc)
@@ -571,7 +584,7 @@ 
 
     /**
      * Replace property annotations in doc comment
-     * @param $doc
+     * @param string $doc
      * @param $properties
      * @return string
      */
@@ -739,6 +752,9 @@ 
         return [$className, $phpdoc];
     }
 
+    /**
+     * @param string $pattern
+     */
     protected function match($pattern, $subject, $split = false)
     {
         $sets = [];
@@ -760,6 +776,9 @@ 
         return $sets;
     }
 
+    /**
+     * @param string $str
+     */
     protected function fixSentence($str)
     {
         // TODO fix word wrap
@@ -768,6 +787,9 @@ 
         return strtoupper(substr($str, 0, 1)) . substr($str, 1) . ($str[strlen($str) - 1] != '.' ? '.' : '');
     }
 
+    /**
+     * @param string $param
+     */
     protected function getPropParam($prop, $param)
     {
         return isset($prop['property']) ? $prop['property'][$param] : (isset($prop['get']) ? $prop['get'][$param] : $prop['set'][$param]);

build/controllers/ReleaseController.php

Doc Comments +23 added lines, -1 removed lines

@@ -337,7 +337,7 @@ 
 
     /**
      * @param array $what list of items
-     * @param array $limit list of things to allow, or empty to allow any, can be `app`, `framework`, `extension`
+     * @param string[] $limit list of things to allow, or empty to allow any, can be `app`, `framework`, `extension`
      * @throws \yii\base\Exception
      */
     protected function validateWhat(array $what, $limit = [])
@@ -503,6 +503,10 @@ 
 
     }
 
+    /**
+     * @param string $name
+     * @param string $path
+     */
     protected function releaseApplication($name, $path, $version)
     {
         $this->stdout("\n");
@@ -603,6 +607,9 @@ 
         Yii::setAlias('@app', $this->_oldAlias);
     }
 
+    /**
+     * @param string $name
+     */
     protected function packageApplication($name, $version, $packagePath)
     {
         FileHelper::createDirectory($packagePath);
@@ -762,6 +769,9 @@ 
     }
 
 
+    /**
+     * @param string[] $what
+     */
     protected function closeChangelogs($what, $version)
     {
         $v = str_replace('\\-', '[\\- ]', preg_quote($version, '/'));
@@ -773,6 +783,9 @@ 
         );
     }
 
+    /**
+     * @param string[] $what
+     */
     protected function openChangelogs($what, $version)
     {
         $headline = "\n$version under development\n";
@@ -789,6 +802,9 @@ 
         }
     }
 
+    /**
+     * @param string[] $what
+     */
     protected function resortChangelogs($what, $version)
     {
         foreach($this->getChangelogs($what) as $file) {
@@ -923,6 +939,9 @@ 
             $frameworkPath . '/BaseYii.php');
     }
 
+    /**
+     * @param string $pattern
+     */
     protected function sed($pattern, $replace, $files)
     {
         foreach((array) $files as $file) {
@@ -955,6 +974,9 @@ 
     const MINOR = 'minor';
     const PATCH = 'patch';
 
+    /**
+     * @param string $type
+     */
     protected function getNextVersions(array $versions, $type)
     {
         foreach($versions as $k => $v) {

framework/behaviors/AttributeBehavior.php

Doc Comments +1 added lines, -1 removed lines

@@ -129,7 +129,7 @@
      * This method is called by [[evaluateAttributes()]]. Its return value will be assigned
      * to the attributes corresponding to the triggering event.
      * @param Event $event the event that triggers the current attribute updating.
-     * @return mixed the attribute value
+     * @return string the attribute value
      */
     protected function getValue($event)
     {

framework/captcha/CaptchaAction.php

Doc Comments +1 added lines, -1 removed lines

@@ -144,7 +144,7 @@
     /**
      * Generates a hash code that can be used for client side validation.
      * @param string $code the CAPTCHA code
-     * @return string a hash code generated from the CAPTCHA code
+     * @return integer a hash code generated from the CAPTCHA code
      */
     public function generateValidationHash($code)
     {

framework/console/Controller.php

Doc Comments +2 added lines, -2 removed lines

@@ -270,7 +270,7 @@ 
      *
      * @param string $message to echo out before waiting for user input
      * @param boolean $default this value is returned if no selection is made.
-     * @return boolean whether user confirmed.
+     * @return boolean|null whether user confirmed.
      * Will return true if [[interactive]] is false.
      */
     public function confirm($message, $default = false)
@@ -306,7 +306,7 @@ 
      * until [[beforeAction()]] is being called.
      *
      * @param string $actionID the action id of the current request
-     * @return array the names of the options valid for the action
+     * @return string[] the names of the options valid for the action
      */
     public function options($actionID)
     {

framework/console/controllers/CacheController.php

Doc Comments +1 added lines, -1 removed lines

@@ -231,7 +231,7 @@
     /**
      * Prompts user with confirmation if caches should be flushed.
      * @param array $cachesNames
-     * @return boolean
+     * @return boolean|null
      */
     private function confirmFlush($cachesNames)
     {

framework/console/controllers/FixtureController.php

Doc Comments +2 added lines, -2 removed lines

@@ -310,7 +310,7 @@ 
      * Prompts user with confirmation if fixtures should be loaded.
      * @param array $fixtures
      * @param array $except
-     * @return boolean
+     * @return boolean|null
      */
     private function confirmLoad($fixtures, $except)
     {
@@ -342,7 +342,7 @@ 
      * Prompts user with confirmation for fixtures that should be unloaded.
      * @param array $fixtures
      * @param array $except
-     * @return boolean
+     * @return boolean|null
      */
     private function confirmUnload($fixtures, $except)
     {

framework/console/controllers/MessageController.php

Doc Comments +1 added lines, -1 removed lines

@@ -594,7 +594,7 @@
      * Finds out a line of the first non-char PHP token found
      *
      * @param array $tokens
-     * @return integer|string
+     * @return string
      * @since 2.0.1
      */
     protected function getLine($tokens)

framework/db/ActiveQuery.php

Doc Comments +1 added lines, -1 removed lines

@@ -392,7 +392,7 @@
      * @param boolean|array $eagerLoading whether to eager load the relations specified in `$with`.
      * When this is a boolean, it applies to all relations specified in `$with`. Use an array
      * to explicitly list which relations in `$with` need to be eagerly loaded. Defaults to `true`.
-     * @param string|array $joinType the join type of the relations specified in `$with`.
+     * @param string $joinType the join type of the relations specified in `$with`.
      * When this is a string, it applies to all relations specified in `$with`. Use an array
      * in the format of `relationName => joinType` to specify different join types for different relations.
      * @return $this the query object itself