phpdoc_trim_consecutive_blank_line_separation.rst

Rule phpdoc_trim_consecutive_blank_line_separation

Removes extra blank lines after summary and after description in PHPDoc.

Examples

Example #1

--- Original
+++ New
 <?php
 /**
  * Summary.
  *
- *
  * Description that contain 4 lines,
  *
  *
  * while 2 of them are blank!
  *
- *
  * @param string $foo
- *
  *
  * @dataProvider provideFixCases
  */
 function fnc($foo) {}

Rule sets

The rule is part of the following rule sets:

• @PhpCsFixer
• @Symfony

References

• Fixer class: PhpCsFixer\Fixer\Phpdoc\PhpdocTrimConsecutiveBlankLineSeparationFixer
• Test class: PhpCsFixer\Tests\Fixer\Phpdoc\PhpdocTrimConsecutiveBlankLineSeparationFixerTest

The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.