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

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/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

framework/db/ActiveRecord.php

Doc Comments +1 added lines, -1 removed lines

@@ -323,7 +323,7 @@
     /**
      * Returns the list of all attribute names of the model.
      * The default implementation will return all column names of the table associated with this AR class.
-     * @return array list of attribute names.
+     * @return integer[] list of attribute names.
      */
     public function attributes()
     {

framework/db/ActiveRelationTrait.php

Doc Comments +2 added lines, -2 removed lines

@@ -187,7 +187,7 @@ 
      * Finds the related records and populates them into the primary models.
      * @param string $name the relation name
      * @param array $primaryModels primary models
-     * @return array the related models
+     * @return ActiveRecordInterface[] the related models
      * @throws InvalidConfigException if [[link]] is invalid
      */
     public function populateRelation($name, &$primaryModels)
@@ -343,7 +343,7 @@ 
     }
 
     /**
-     * @param array $models
+     * @param ActiveRecordInterface[] $models
      * @param array $link
      * @param array $viaModels
      * @param array $viaLink

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 integer $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/db/oci/Schema.php

Doc Comments +1 added lines

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

framework/db/Query.php

Doc Comments +1 added lines, -1 removed lines

@@ -842,7 +842,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
      */