Php-cs-fixer: PhpDoc: no extra empty lines

[keradus]

Target: 1.x line

Code before:

<?php

/**
 * Description.
 *
 *
 * @var int
 */
$foo = 1;

Code after:

<?php

/**
 * Description.
 *
 * @var int
 */
$foo = 1;

[GrahamCampbell]

We already have a fixer that nearly does that.

[keradus]

Updated feature specification to not partially duplicate PhpdocTrimFixer

[GrahamCampbell]

I didn't originally add a fixer like this on purpose because the integration testing across lots of php repos showed that sometimes multiple lines breaks where indeed wanted, say when using complex markdown or code examples inside the phpdoc.

[keradus]

It should not touch content of part of docblock (like annotation/description/summary), but the space between them.
And even if we could not reach that - the fixer would be useful for some repos ;)

[GrahamCampbell]

Sure. This should be quite easy to implement.

[keradus]

/**
 * Summary.
 *
 *
 * Description.
 *
 *
 * @var int
 *
 *
 * @return int
 *
 *
 * foo
 */
$foo = 1;

Extra blank line shall be removed after Summary and after Description.
One between annotations is already removed by phpdoc_separation, probably it shall not do it anymore and it shall be done only by new fixer.

[julienfalque]

Why reopening the issue?

[SpacePossum]

because I think there are still cases where PhpDoc's have extra empty lines which can/should be removed. Example:

final class ClassKeywordRemoveFixerTest extends AbstractFixerTestCase
{
    /**
     * @param string      $expected
     * @param null|string $input
     *
     *
     *
     *
     * @dataProvider provideFixCases
     */
    public function testFix($expected, $input = null)
    {
        $this->doTest($expected, $input);
    }
}

[keradus]

would you be fine guys to trim any consecutive blank lines, not only ones after summary/description ?
(as one, single fixer, no config)

[keradus]

ref #3802