rob006 / yii2-dev

build/controllers/PhpDocController.php

Doc Comments +24 added lines, -2 removed lines

@@ -113,6 +113,9 @@ 
         return array_merge(parent::options($actionID), ['updateFiles', 'skipFrameworkRequirements']);
     }
 
+    /**
+     * @param string|null $root
+     */
     protected function findFiles($root, $needsInclude = true)
     {
         $except = [];
@@ -233,6 +236,9 @@ 
         return FileHelper::findFiles($root, $options);
     }
 
+    /**
+     * @param string $extensionPath
+     */
     private function setUpExtensionAliases($extensionPath)
     {
         foreach (scandir($extensionPath) as $extension) {
@@ -340,6 +346,9 @@ 
         }
     }
 
+    /**
+     * @param string $line
+     */
     protected function fixParamTypes($line)
     {
         return preg_replace_callback('~@(param|return) ([\w\\|]+)~i', function ($matches) {
@@ -476,6 +485,10 @@ 
         // TODO
     }
 
+    /**
+     * @param null|string $className
+     * @param string $propertyDoc
+     */
     protected function updateClassPropertyDocs($file, $className, $propertyDoc)
     {
         try {
@@ -556,7 +569,7 @@ 
     /**
      * remove multi empty lines and trim trailing whitespace.
      *
-     * @param $doc
+     * @param string $doc
      * @return string
      */
     protected function cleanDocComment($doc)
@@ -575,7 +588,7 @@ 
 
     /**
      * Replace property annotations in doc comment.
-     * @param $doc
+     * @param string $doc
      * @param $properties
      * @return string
      */
@@ -742,6 +755,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
@@ -776,6 +795,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]);

build/controllers/ReleaseController.php

Doc Comments +20 added lines, -1 removed lines

@@ -368,7 +368,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`
      * @param bool $ensureGitClean
      * @throws \yii\base\Exception
      */
@@ -548,6 +548,10 @@ 
         $this->stdout("\n");
     }
 
+    /**
+     * @param string $name
+     * @param string $path
+     */
     protected function releaseApplication($name, $path, $version)
     {
         $this->stdout("\n");
@@ -650,6 +654,9 @@ 
         Yii::setAlias('@app', $this->_oldAlias);
     }
 
+    /**
+     * @param string $name
+     */
     protected function packageApplication($name, $version, $packagePath)
     {
         FileHelper::createDirectory($packagePath);
@@ -811,6 +818,9 @@ 
     }
 
 
+    /**
+     * @param string[] $what
+     */
     protected function closeChangelogs($what, $version)
     {
         $v = str_replace('\\-', '[\\- ]', preg_quote($version, '/'));
@@ -822,6 +832,9 @@ 
         );
     }
 
+    /**
+     * @param string[] $what
+     */
     protected function openChangelogs($what, $version)
     {
         $headline = "\n$version under development\n";
@@ -986,6 +999,9 @@ 
             $frameworkPath . '/BaseYii.php');
     }
 
+    /**
+     * @param string $pattern
+     */
     protected function sed($pattern, $replace, $files)
     {
         foreach ((array) $files as $file) {
@@ -1019,6 +1035,9 @@ 
     const MINOR = 'minor';
     const PATCH = 'patch';
 
+    /**
+     * @param string $type
+     */
     protected function getNextVersions(array $versions, $type)
     {
         foreach ($versions as $k => $v) {

framework/console/controllers/MessageController.php

Doc Comments +1 added lines, -1 removed lines

@@ -623,7 +623,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/i18n/MessageFormatter.php

Doc Comments +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
     /**
      * Get the error code from the last operation.
      * @link http://php.net/manual/en/messageformatter.geterrorcode.php
-     * @return string Code of the last error.
+     * @return integer Code of the last error.
      */
     public function getErrorCode()
     {

framework/validators/DateValidator.php

Doc Comments +1 added lines, -1 removed lines

@@ -321,7 +321,7 @@
      * Parses date string into UNIX timestamp.
      *
      * @param string $value string representing date
-     * @return int|false a UNIX timestamp or `false` on failure.
+     * @return integer a UNIX timestamp or `false` on failure.
      */
     protected function parseDateValue($value)
     {

framework/web/UrlManager.php

Doc Comments +3 added lines, -3 removed lines

@@ -453,7 +453,7 @@ 
      * @param string $cacheKey generated cache key to store data.
      * @param string $route the route (e.g. `site/index`).
      * @param array $params rule params.
-     * @return bool|string the created URL
+     * @return string|false the created URL
      * @see createUrl()
      * @since 2.0.8
      */
@@ -475,7 +475,7 @@ 
 
     /**
      * Store rule (e.g. [[UrlRule]]) to internal cache.
-     * @param $cacheKey
+     * @param string $cacheKey
      * @param UrlRuleInterface $rule
      * @since 2.0.8
      */
@@ -492,7 +492,7 @@ 
      * Note that unlike [[\yii\helpers\Url::toRoute()]], this method always treats the given route
      * as an absolute route.
      *
-     * @param string|array $params use a string to represent a route (e.g. `site/index`),
+     * @param string[] $params use a string to represent a route (e.g. `site/index`),
      * or an array to represent a route with query parameters (e.g. `['site/index', 'param1' => 'value1']`).
      * @param string|null $scheme the scheme to use for the URL (either `http`, `https` or empty string
      * for protocol-relative URL).