Squiz/FunctionSpacing: fixer is broken with doc comment on closing brace line

[klausi]

The fixer in Squiz.WhiteSpace.FunctionSpacing gets confused when there is a doc comment on the closing brace line:

Description

Solves this fixer infinite loop

/**
 * foo.
 */
function a() {
}/**
 * foo.
 */
function b() {
}

Suggested changelog entry

Squiz.WhiteSpace.FunctionSpacing: Fix the fixer when there is a doc comment on the function closing line.

Related issues/external references

https://www.drupal.org/project/coder/issues/3461139

Types of changes

• Bug fix (non-breaking change which fixes an issue)

PR checklist

• I have checked there is no other PR open for the same change.
• I have read the Contribution Guidelines.
• I grant the project the right to include and distribute the code under the BSD-3-Clause license (and I have the right to grant these rights).
• I have added tests to cover my changes.
• I have verified that the code complies with the projects coding standards.

[jrfnl]

I can confirm the sniff getting into a fixer conflict with itself with the provided code sample and that the patch fixes this.

Generally speaking this sniff doesn't care about other content on the same line as the function declaration. Code like the below will not be flagged by the sniff:

function c() {} function d() {}

But in the case of a "trailing" docblock, this meant that the sniff was adding the new lines within the doc block, which, in turn, meant it would still not see the "blank lines after" in the next loop, as the added lines would be seen as doc comment lines, not blank lines. Hence, the fixer conflict.

Thanks for fixing this @klausi !