yiisoft / yii2

framework/db/Migration.php

Doc Comments +8 added lines, -8 removed lines

@@ -105,7 +105,7 @@ 
     /**
      * This method contains the logic to be executed when applying this migration.
      * Child classes may override this method to provide actual migration logic.
-     * @return bool return a false value to indicate the migration fails
+     * @return false|null return a false value to indicate the migration fails
      * and should not proceed further. All other return values mean the migration succeeds.
      */
     public function up()
@@ -134,7 +134,7 @@ 
      * This method contains the logic to be executed when removing this migration.
      * The default implementation throws an exception indicating the migration cannot be removed.
      * Child classes may override this method if the corresponding migrations can be removed.
-     * @return bool return a false value to indicate the migration fails
+     * @return false|null return a false value to indicate the migration fails
      * and should not proceed further. All other return values mean the migration succeeds.
      */
     public function down()
@@ -178,7 +178,7 @@ 
      * Note: Not all DBMS support transactions. And some DB queries cannot be put into a transaction. For some examples,
      * please refer to [implicit commit](http://dev.mysql.com/doc/refman/5.7/en/implicit-commit.html).
      *
-     * @return bool return a false value to indicate the migration fails
+     * @return boolean|null return a false value to indicate the migration fails
      * and should not proceed further. All other return values mean the migration succeeds.
      */
     public function safeUp()
@@ -195,7 +195,7 @@ 
      * Note: Not all DBMS support transactions. And some DB queries cannot be put into a transaction. For some examples,
      * please refer to [implicit commit](http://dev.mysql.com/doc/refman/5.7/en/implicit-commit.html).
      *
-     * @return bool return a false value to indicate the migration fails
+     * @return boolean|null return a false value to indicate the migration fails
      * and should not proceed further. All other return values mean the migration succeeds.
      */
     public function safeDown()
@@ -406,7 +406,7 @@ 
      * The method will properly quote the table and column names.
      * @param string $name the name of the primary key constraint.
      * @param string $table the table that the primary key constraint will be added to.
-     * @param string|array $columns comma separated string or array of columns that the primary key will consist of.
+     * @param string[] $columns comma separated string or array of columns that the primary key will consist of.
      */
     public function addPrimaryKey($name, $table, $columns)
     {
@@ -432,9 +432,9 @@ 
      * The method will properly quote the table and column names.
      * @param string $name the name of the foreign key constraint.
      * @param string $table the table that the foreign key constraint will be added to.
-     * @param string|array $columns the name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas or use an array.
+     * @param string $columns the name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas or use an array.
      * @param string $refTable the table that the foreign key references to.
-     * @param string|array $refColumns the name of the column that the foreign key references to. If there are multiple columns, separate them with commas or use an array.
+     * @param string $refColumns the name of the column that the foreign key references to. If there are multiple columns, separate them with commas or use an array.
      * @param string $delete the ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
      * @param string $update the ON UPDATE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
      */
@@ -461,7 +461,7 @@ 
      * Builds and executes a SQL statement for creating a new index.
      * @param string $name the name of the index. The name will be properly quoted by the method.
      * @param string $table the table that the new index will be created for. The table name will be properly quoted by the method.
-     * @param string|array $columns the column(s) that should be included in the index. If there are multiple columns, please separate them
+     * @param string $columns the column(s) that should be included in the index. If there are multiple columns, please separate them
      * by commas or use an array. Each column name will be properly quoted by the method. Quoting will be skipped for column names that
      * include a left parenthesis "(".
      * @param bool $unique whether to add UNIQUE constraint on the created index.

framework/helpers/BaseArrayHelper.php

Doc Comments +5 added lines, -5 removed lines

@@ -112,7 +112,7 @@ 
      * @param array $a array to be merged to
      * @param array $b array to be merged from. You can specify additional
      * arrays via third argument, fourth argument etc.
-     * @return array the merged array (the original arrays are not changed.)
+     * @return callable the merged array (the original arrays are not changed.)
      */
     public static function merge($a, $b)
     {
@@ -447,7 +447,7 @@ 
      * ```
      *
      * @param array $array the array that needs to be indexed or grouped
-     * @param string|\Closure|null $key the column name or anonymous function which result will be used to index the array
+     * @param null|string $key the column name or anonymous function which result will be used to index the array
      * @param string|string[]|\Closure[]|null $groups the array of keys, that will be used to group the input array
      * by one or more keys. If the $key attribute or its value for the particular element is null and $groups is not
      * defined, the array element will be discarded. Otherwise, if $groups is specified, array element will be added
@@ -567,8 +567,8 @@ 
      * ```
      *
      * @param array $array
-     * @param string|\Closure $from
-     * @param string|\Closure $to
+     * @param string $from
+     * @param string $to
      * @param string|\Closure $group
      * @return array
      */
@@ -623,7 +623,7 @@ 
      * To sort by multiple keys, provide an array of keys here.
      * @param int|array $direction the sorting direction. It can be either `SORT_ASC` or `SORT_DESC`.
      * When sorting by multiple keys with different sorting directions, use an array of sorting directions.
-     * @param int|array $sortFlag the PHP sort flag. Valid values include
+     * @param integer $sortFlag the PHP sort flag. Valid values include
      * `SORT_REGULAR`, `SORT_NUMERIC`, `SORT_STRING`, `SORT_LOCALE_STRING`, `SORT_NATURAL` and `SORT_FLAG_CASE`.
      * Please refer to [PHP manual](http://php.net/manual/en/function.sort.php)
      * for more details. When sorting by multiple keys with different sort flags, use an array of sort flags.

framework/helpers/BaseStringHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -355,7 +355,7 @@
      * Safely casts a float to string independent of the current locale.
      *
      * The decimal separator will always be `.`.
-     * @param float|int $number a floating point number or integer.
+     * @param double $number a floating point number or integer.
      * @return string the string representation of the number.
      * @since 2.0.13
      */

framework/db/BaseActiveRecord.php

Doc Comments +1 added lines, -1 removed lines

@@ -100,7 +100,7 @@
 
     /**
      * {@inheritdoc}
-     * @return static|null ActiveRecord instance matching the condition, or `null` if nothing matches.
+     * @return BaseActiveRecord ActiveRecord instance matching the condition, or `null` if nothing matches.
      */
     public static function findOne($condition)
     {

framework/db/oci/Schema.php

Doc Comments +1 added lines

@@ -240,6 +240,7 @@
 
     /**
      * {@inheritdoc}
+     * @param string $name
      */
     public function quoteSimpleTableName($name)
     {

framework/db/sqlite/QueryBuilder.php

Doc Comments +1 added lines

@@ -466,6 +466,7 @@
 
     /**
      * {@inheritdoc}
+     * @param Query $query
      */
     public function build($query, $params = [])
     {

framework/log/SyslogTarget.php

Doc Comments +1 added lines

@@ -73,6 +73,7 @@
 
     /**
      * {@inheritdoc}
+     * @return string
      */
     public function formatMessage($message)
     {

build/controllers/PhpDocController.php

Doc Comments +15 added lines, -2 removed lines

@@ -502,6 +502,10 @@ 
         // TODO
     }
 
+    /**
+     * @param null|string $className
+     * @param string $propertyDoc
+     */
     protected function updateClassPropertyDocs($file, $className, $propertyDoc)
     {
         try {
@@ -582,7 +586,7 @@ 
     /**
      * remove multi empty lines and trim trailing whitespace.
      *
-     * @param $doc
+     * @param string $doc
      * @return string
      */
     protected function cleanDocComment($doc)
@@ -601,7 +605,7 @@ 
 
     /**
      * Replace property annotations in doc comment.
-     * @param $doc
+     * @param string $doc
      * @param $properties
      * @return string
      */
@@ -768,6 +772,9 @@ 
         return [$className, $phpdoc];
     }
 
+    /**
+     * @param string $pattern
+     */
     protected function match($pattern, $subject, $split = false)
     {
         $sets = [];
@@ -792,6 +799,9 @@ 
         return $sets;
     }
 
+    /**
+     * @param string $str
+     */
     protected function fixSentence($str)
     {
         // TODO fix word wrap
@@ -802,6 +812,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]);