php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-08-26 06:15:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

Enable phpdoc_summary rule in php-cs-fixer config (#14675)

Browse Source 
* Enable `phpdoc_summary` rule in php-cs-fixer config.

* Fix case in "PHPDoc".
This commit is contained in:
Robert Korulczyk
2017-08-21 11:19:35 +02:00
committed by Carsten Brandt
parent 1501c659ac
commit 5a8c3d537b
248 changed files with 624 additions and 510 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
build/controllers/PhpDocController.php
View File

@ -13,7 +13,7 @@ use yii\helpers\Console;
use yii\helpers\FileHelper;
/**
* PhpDocController is there to help maintaining PHPDoc annotation in class files
* PhpDocController is there to help maintaining PHPDoc annotation in class files.
*
* @author Carsten Brandt <mail@cebe.cc>
* @author Alexander Makarov <sam@rmcreative.ru>
@ -34,7 +34,7 @@ class PhpDocController extends Controller
/**
* Generates `@property` annotations in class files from getters and setters
* Generates `@property` annotations in class files from getters and setters.
*
* Property description will be taken from getter or setter or from an `@property` annotation
* in the getters docblock if there is one defined.
@ -70,7 +70,7 @@ class PhpDocController extends Controller
}
/**
* Fix some issues with PHPdoc in files
* Fix some issues with PHPDoc in files.
*
* @param string $root the directory to parse files from. Defaults to YII2_PATH.
*/
@ -243,7 +243,7 @@ class PhpDocController extends Controller
}
/**
* Fix file PHPdoc
* Fix file PHPDoc.
*/
protected function fixFileDoc(&$lines)
{
@ -284,7 +284,7 @@ class PhpDocController extends Controller
}
/**
* Markdown aware fix of whitespace issues in doc comments
* Markdown aware fix of whitespace issues in doc comments.
*/
protected function fixDocBlockIndentation(&$lines)
{
@ -356,7 +356,7 @@ class PhpDocController extends Controller
}
/**
* Fixes line spacing code style for properties and constants
* Fixes line spacing code style for properties and constants.
* @param string[] $lines
* @return string[]
*/
@ -554,7 +554,7 @@ class PhpDocController extends Controller
}
/**
* remove multi empty lines and trim trailing whitespace
* remove multi empty lines and trim trailing whitespace.
*
* @param $doc
* @return string
@ -574,7 +574,7 @@ class PhpDocController extends Controller
}
/**
* Replace property annotations in doc comment
* Replace property annotations in doc comment.
* @param $doc
* @param $properties
* @return string