yiisoft / yii2

framework/requirements/YiiRequirementChecker.php

Doc Comments +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
      * Check the given requirements, collecting results into internal field.
      * This method can be invoked several times checking different requirement sets.
      * Use [[getResult()]] or [[render()]] to get the results.
-     * @param array|string $requirements requirements to be checked.
+     * @param string $requirements requirements to be checked.
      * If an array, it is treated as the set of requirements;
      * If a string, it is treated as the path of the file, which contains the requirements;
      * @return $this self instance.

framework/web/Request.php

Doc Comments +1 added lines, -1 removed lines

@@ -426,7 +426,7 @@
      * If the parameter does not exist, the second parameter passed to this method will be returned.
      * @param string $name the parameter name
      * @param mixed $defaultValue the default parameter value if the parameter does not exist.
-     * @return mixed the parameter value
+     * @return string the parameter value
      * @see getBodyParams()
      * @see setBodyParams()
      */

framework/web/Response.php

Doc Comments +1 added lines, -1 removed lines

@@ -726,7 +726,7 @@
      * });
      * ~~~
      *
-     * @param string|array $url the URL to be redirected to. This can be in one of the following formats:
+     * @param string $url the URL to be redirected to. This can be in one of the following formats:
      *
      * - a string representing a URL (e.g. "http://example.com")
      * - a string representing a URL alias (e.g. "@example.com")

framework/web/User.php

Doc Comments +2 added lines, -2 removed lines

@@ -163,7 +163,7 @@ 
      * stored in session and reconstruct the corresponding identity object, if it has not done so before.
      * @param boolean $autoRenew whether to automatically renew authentication status if it has not been done so before.
      * This is only useful when [[enableSession]] is true.
-     * @return IdentityInterface|null the identity object associated with the currently logged-in user.
+     * @return null|boolean the identity object associated with the currently logged-in user.
      * `null` is returned if the user is not logged in (not authenticated).
      * @see login()
      * @see logout()
@@ -254,7 +254,7 @@ 
      * with the provided access token. If successful, it will call [[login()]] to log in the authenticated user.
      * If authentication fails or [[login()]] is unsuccessful, it will return null.
      * @param string $token the access token
-     * @param mixed $type the type of the token. The value of this parameter depends on the implementation.
+     * @param string $type the type of the token. The value of this parameter depends on the implementation.
      * For example, [[\yii\filters\auth\HttpBearerAuth]] will set this parameter to be `yii\filters\auth\HttpBearerAuth`.
      * @return IdentityInterface|null the identity associated with the given access token. Null is returned if
      * the access token is invalid or [[login()]] is unsuccessful.

framework/widgets/LinkPager.php

Doc Comments +1 added lines, -1 removed lines

@@ -224,7 +224,7 @@
     }
 
     /**
-     * @return array the begin and end pages that need to be displayed.
+     * @return integer[] the begin and end pages that need to be displayed.
      */
     protected function getPageRange()
     {

framework/db/Query.php

Doc Comments +1 added lines, -1 removed lines

@@ -795,7 +795,7 @@
 
     /**
      * Appends a SQL statement using UNION operator.
-     * @param string|Query $sql the SQL statement to be appended using UNION
+     * @param Query $sql the SQL statement to be appended using UNION
      * @param boolean $all TRUE if using UNION ALL and FALSE if using UNION
      * @return $this the query object itself
      */

framework/behaviors/AttributeBehavior.php

Doc Comments +1 added lines, -1 removed lines

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

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

framework/web/ViewAction.php

Unused Use Statements -1 removed lines

@@ -9,7 +9,6 @@
 
 use Yii;
 use yii\base\Action;
-use yii\base\InvalidParamException;
 use yii\base\ViewNotFoundException;
 
 /**