yiisoft / yii2

framework/log/Logger.php

Doc Comments +2 added lines, -2 removed lines

@@ -196,7 +196,7 @@ 
      * `$categories` and `$excludeCategories` as parameters to retrieve the
      * results that you are interested in.
      *
-     * @param array $categories list of categories that you are interested in.
+     * @param string[] $categories list of categories that you are interested in.
      * You can use an asterisk at the end of a category to do a prefix match.
      * For example, 'yii\db\*' will match categories starting with 'yii\db\',
      * such as 'yii\db\Connection'.
@@ -246,7 +246,7 @@ 
      * Returns the statistical results of DB queries.
      * The results returned include the number of SQL statements executed and
      * the total time spent.
-     * @return array the first element indicates the number of SQL statements executed,
+     * @return integer[] the first element indicates the number of SQL statements executed,
      * and the second element the total time spent in SQL execution.
      */
     public function getDbProfiling()

framework/db/Query.php

Doc Comments +2 added lines, -2 removed lines

@@ -768,7 +768,7 @@ 
 
     /**
      * Sets the GROUP BY part of the query.
-     * @param string|array|Expression $columns the columns to be grouped by.
+     * @param string $columns the columns to be grouped by.
      * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']).
      * The method will automatically quote the column names unless a column contains some parenthesis
      * (which means the column contains a DB expression).
@@ -967,7 +967,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 bool $all TRUE if using UNION ALL and FALSE if using UNION
      * @return $this the query object itself
      */

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)
     {
         try {
@@ -558,7 +571,7 @@ 
     /**
      * remove multi empty lines and trim trailing whitespace
      *
-     * @param $doc
+     * @param string $doc
      * @return string
      */
     protected function cleanDocComment($doc)
@@ -577,7 +590,7 @@ 
 
     /**
      * Replace property annotations in doc comment
-     * @param $doc
+     * @param string $doc
      * @param $properties
      * @return string
      */
@@ -745,6 +758,9 @@ 
         return [$className, $phpdoc];
     }
 
+    /**
+     * @param string $pattern
+     */
     protected function match($pattern, $subject, $split = false)
     {
         $sets = [];
@@ -766,6 +782,9 @@ 
         return $sets;
     }
 
+    /**
+     * @param string $str
+     */
     protected function fixSentence($str)
     {
         // TODO fix word wrap
@@ -774,6 +793,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/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/db/ActiveQuery.php

Doc Comments +1 added lines, -1 removed lines

@@ -392,7 +392,7 @@
      * @param bool|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

framework/db/DataReader.php

Doc Comments +1 added lines, -1 removed lines

@@ -114,7 +114,7 @@
     /**
      * Returns a single column from the next row of a result set.
      * @param int $columnIndex zero-based column index
-     * @return mixed the column of the current row, false if no more rows available
+     * @return string the column of the current row, false if no more rows available
      */
     public function readColumn($columnIndex)
     {

framework/web/Response.php

Doc Comments +1 added lines, -1 removed lines

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

@@ -175,7 +175,7 @@ 
      * stored in session and reconstruct the corresponding identity object, if it has not done so before.
      * @param bool $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()
@@ -259,7 +259,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.

build/controllers/ReleaseController.php

Doc Comments +20 added lines, -1 removed lines

@@ -367,7 +367,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 = [], $ensureGitClean = true)
@@ -547,6 +547,10 @@ 
 
     }
 
+    /**
+     * @param string $name
+     * @param string $path
+     */
     protected function releaseApplication($name, $path, $version)
     {
         $this->stdout("\n");
@@ -649,6 +653,9 @@ 
         Yii::setAlias('@app', $this->_oldAlias);
     }
 
+    /**
+     * @param string $name
+     */
     protected function packageApplication($name, $version, $packagePath)
     {
         FileHelper::createDirectory($packagePath);
@@ -810,6 +817,9 @@ 
     }
 
 
+    /**
+     * @param string[] $what
+     */
     protected function closeChangelogs($what, $version)
     {
         $v = str_replace('\\-', '[\\- ]', preg_quote($version, '/'));
@@ -821,6 +831,9 @@ 
         );
     }
 
+    /**
+     * @param string[] $what
+     */
     protected function openChangelogs($what, $version)
     {
         $headline = "\n$version under development\n";
@@ -977,6 +990,9 @@ 
             $frameworkPath . '/BaseYii.php');
     }
 
+    /**
+     * @param string $pattern
+     */
     protected function sed($pattern, $replace, $files)
     {
         foreach ((array) $files as $file) {
@@ -1009,6 +1025,9 @@ 
     const MINOR = 'minor';
     const PATCH = 'patch';
 
+    /**
+     * @param string $type
+     */
     protected function getNextVersions(array $versions, $type)
     {
         foreach ($versions as $k => $v) {