yiisoft / yii2

build/controllers/PhpDocController.php

Doc Comments +18 added lines, -2 removed lines

@@ -108,6 +108,9 @@ 
         return array_merge(parent::options($actionID), ['updateFiles']);
     }
 
+    /**
+     * @param string|null $root
+     */
     protected function findFiles($root)
     {
         $except = [];
@@ -371,6 +374,10 @@ 
         // TODO
     }
 
+    /**
+     * @param null|string $className
+     * @param string $propertyDoc
+     */
     protected function updateClassPropertyDocs($file, $className, $propertyDoc)
     {
         $ref = new \ReflectionClass($className);
@@ -440,7 +447,7 @@ 
     /**
      * remove multi empty lines and trim trailing whitespace
      *
-     * @param $doc
+     * @param string $doc
      * @return string
      */
     protected function cleanDocComment($doc)
@@ -459,7 +466,7 @@ 
 
     /**
      * Replace property annotations in doc comment
-     * @param $doc
+     * @param string $doc
      * @param $properties
      * @return string
      */
@@ -621,6 +628,9 @@ 
         return [$className, $phpdoc];
     }
 
+    /**
+     * @param string $pattern
+     */
     protected function match($pattern, $subject, $split = false)
     {
         $sets = [];
@@ -642,6 +652,9 @@ 
         return $sets;
     }
 
+    /**
+     * @param string $str
+     */
     protected function fixSentence($str)
     {
         // TODO fix word wrap
@@ -650,6 +663,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]);

framework/base/Model.php

Doc Comments +1 added lines, -1 removed lines

@@ -401,7 +401,7 @@
      * $model->validators[] = $newValidator;
      * ~~~
      *
-     * @return ArrayObject|\yii\validators\Validator[] all the validators declared in the model.
+     * @return ArrayObject all the validators declared in the model.
      */
     public function getValidators()
     {

framework/base/Security.php

Doc Comments +3 added lines, -3 removed lines

@@ -132,7 +132,7 @@ 
      * Verifies and decrypts data encrypted with [[encryptByPassword()]].
      * @param string $data the encrypted data to decrypt
      * @param string $password the password to use for decryption
-     * @return bool|string the decrypted data or false on authentication failure
+     * @return false|string the decrypted data or false on authentication failure
      * @see encryptByPassword()
      */
     public function decryptByPassword($data, $password)
@@ -145,7 +145,7 @@ 
      * @param string $data the encrypted data to decrypt
      * @param string $inputKey the input to use for encryption and authentication
      * @param string $info optional context and application specific information, see [[hkdf()]]
-     * @return bool|string the decrypted data or false on authentication failure
+     * @return false|string the decrypted data or false on authentication failure
      * @see encryptByKey()
      */
     public function decryptByKey($data, $inputKey, $info = null)
@@ -212,7 +212,7 @@ 
      * @param string $secret the decryption password or key
      * @param string $info context/application specific information, @see encrypt()
      *
-     * @return bool|string the decrypted data or false on authentication failure
+     * @return false|string the decrypted data or false on authentication failure
      * @throws InvalidConfigException on OpenSSL not loaded
      * @throws Exception on OpenSSL error
      * @see encrypt()

framework/captcha/CaptchaAction.php

Doc Comments +1 added lines, -1 removed lines

@@ -138,7 +138,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 +4 added lines, -4 removed lines

@@ -183,7 +183,7 @@ 
      * ~~~
      *
      * @param string $string the string to print
-     * @return int|boolean Number of bytes printed or false on error
+     * @return integer Number of bytes printed or false on error
      */
     public function stdout($string)
     {
@@ -208,7 +208,7 @@ 
      * ~~~
      *
      * @param string $string the string to print
-     * @return int|boolean Number of bytes printed or false on error
+     * @return integer Number of bytes printed or false on error
      */
     public function stderr($string)
     {
@@ -248,7 +248,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)
@@ -284,7 +284,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

@@ -225,7 +225,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

@@ -300,7 +300,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)
     {
@@ -329,7 +329,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

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

framework/db/ActiveQuery.php

Doc Comments +1 added lines, -1 removed lines

@@ -385,7 +385,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.
-     * @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