Commit e948b07

committed

Add PhpdocTrimConsecutiveBlankLineSeparationFixer to removes extra blank lines in PHPDoc.

1 parent 8b17b23 commit e948b07Copy full SHA for e948b07

File tree

+11

-2

lines changed

+11

-2

lines changed

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -124,6 +124,7 @@`
`124`	`124`	`use PhpCsFixer\Fixer\Phpdoc\PhpdocScalarFixer;`
`125`	`125`	`use PhpCsFixer\Fixer\Phpdoc\PhpdocSingleLineVarSpacingFixer;`
`126`	`126`	`use PhpCsFixer\Fixer\Phpdoc\PhpdocToCommentFixer;`
	`127`	`+use PhpCsFixer\Fixer\Phpdoc\PhpdocTrimConsecutiveBlankLineSeparationFixer;`
`127`	`128`	`use PhpCsFixer\Fixer\Phpdoc\PhpdocTrimFixer;`
`128`	`129`	`use PhpCsFixer\Fixer\Phpdoc\PhpdocTypesFixer;`
`129`	`130`	`use PhpCsFixer\Fixer\Phpdoc\PhpdocVarAnnotationCorrectOrderFixer;`
`@@ -372,6 +373,8 @@`
`372`	`373`	`PhpdocScalarFixer::class,`
`373`	`374`	// Single line `@var` PHPDoc should have proper spacing.
`374`	`375`	`PhpdocSingleLineVarSpacingFixer::class,`
	`376`	`+ // Removes extra blank lines after summary and after description in PHPDoc.`
	`377`	`+ PhpdocTrimConsecutiveBlankLineSeparationFixer::class,`
`375`	`378`	`// PHPDoc should start and end with content`
`376`	`379`	`PhpdocTrimFixer::class,`
`377`	`380`	`// Docblocks should only be used on structural elements.`

Lines changed: 3 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,9 @@ class PhpDoc`
`12`	`12`
`13`	`13`	`/**`
`14`	`14`	`* Very well documented method.`
`15`		`- * It tests PhpdocAlignFixer, NoSuperfluousPhpdocTagsFixer and possibly other Phpdoc rules.`
	`15`	`+ * It tests PhpdocAlignFixer, NoSuperfluousPhpdocTagsFixer, PhpdocTrimConsecutiveBlankLineSeparationFixer`
	`16`	`+ * and possibly other Phpdoc rules.`
	`17`	`+ *`
`16`	`18`	`* @param int\|float $second Second parameter does have a comment, unlike the first one.`
`17`	`19`	`* @param string\|null $third Third parameter is optional and has a default value.`
`18`	`20`	`* @return mixed There is also information about return type.`

Lines changed: 5 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,11 @@ class PhpDoc`
`15`	`15`
`16`	`16`	`/**`
`17`	`17`	`* Very well documented method.`
`18`		`- * It tests PhpdocAlignFixer, NoSuperfluousPhpdocTagsFixer and possibly other Phpdoc rules.`
	`18`	`+ * It tests PhpdocAlignFixer, NoSuperfluousPhpdocTagsFixer, PhpdocTrimConsecutiveBlankLineSeparationFixer`
	`19`	`+ * and possibly other Phpdoc rules.`
	`20`	`+ *`
	`21`	`+ *`
	`22`	`+ *`
`19`	`23`	`* @param string $first`
`20`	`24`	`* @throws \Exception`
`21`	`25`	`* @param int\|float $second Second parameter does have a comment, unlike the first one.`

Comments

(0)