yiisoft / yii2

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) {
@@ -473,6 +482,10 @@ 
         // TODO
     }
 
+    /**
+     * @param null|string $className
+     * @param string $propertyDoc
+     */
     protected function updateClassPropertyDocs($file, $className, $propertyDoc)
     {
         try {
@@ -553,7 +566,7 @@ 
     /**
      * remove multi empty lines and trim trailing whitespace
      *
-     * @param $doc
+     * @param string $doc
      * @return string
      */
     protected function cleanDocComment($doc)
@@ -572,7 +585,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 = [];
@@ -762,6 +778,9 @@ 
         return $sets;
     }
 
+    /**
+     * @param string $str
+     */
     protected function fixSentence($str)
     {
         // TODO fix word wrap
@@ -771,6 +790,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

@@ -366,7 +366,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)
@@ -545,6 +545,10 @@ 
         $this->stdout("\n");
     }
 
+    /**
+     * @param string $name
+     * @param string $path
+     */
     protected function releaseApplication($name, $path, $version)
     {
         $this->stdout("\n");
@@ -647,6 +651,9 @@ 
         Yii::setAlias('@app', $this->_oldAlias);
     }
 
+    /**
+     * @param string $name
+     */
     protected function packageApplication($name, $version, $packagePath)
     {
         FileHelper::createDirectory($packagePath);
@@ -808,6 +815,9 @@ 
     }
 
 
+    /**
+     * @param string[] $what
+     */
     protected function closeChangelogs($what, $version)
     {
         $v = str_replace('\\-', '[\\- ]', preg_quote($version, '/'));
@@ -819,6 +829,9 @@ 
         );
     }
 
+    /**
+     * @param string[] $what
+     */
     protected function openChangelogs($what, $version)
     {
         $headline = "\n$version under development\n";
@@ -975,6 +988,9 @@ 
             $frameworkPath . '/BaseYii.php');
     }
 
+    /**
+     * @param string $pattern
+     */
     protected function sed($pattern, $replace, $files)
     {
         foreach ((array) $files as $file) {
@@ -1007,6 +1023,9 @@ 
     const MINOR = 'minor';
     const PATCH = 'patch';
 
+    /**
+     * @param string $type
+     */
     protected function getNextVersions(array $versions, $type)
     {
         foreach ($versions as $k => $v) {