diff --git a/README.md b/README.md index f4ee7707..4f54f3fe 100644 --- a/README.md +++ b/README.md @@ -145,11 +145,11 @@ Fixes @param, @return, `@var` and inline `@var` annotations broken formats
-## RemoveSetterGetterDocblockFixer +## RemoveMethodNameDuplicateDescriptionFixer -Remove docblock description from getter/setter methods, that only repeats the method name +Remove docblock descriptions which duplicate their method name -- class: [`Symplify\CodingStandard\Fixer\Annotation\RemoveSetterGetterDocblockFixer`](../src/Fixer/Annotation/RemoveSetterGetterDocblockFixer.php) +- class: [`Symplify\CodingStandard\Fixer\Annotation\RemoveRedundantDescriptionFixer`](../src/Fixer/Annotation/RemoveRedundantDescriptionFixer.php) ```diff /** diff --git a/config/symplify.php b/config/symplify.php index 5ab61277..4867109f 100644 --- a/config/symplify.php +++ b/config/symplify.php @@ -4,7 +4,7 @@ use PhpCsFixer\Fixer\Phpdoc\GeneralPhpdocAnnotationRemoveFixer; use Symplify\CodingStandard\Fixer\Annotation\RemovePHPStormAnnotationFixer; -use Symplify\CodingStandard\Fixer\Annotation\RemoveSetterGetterDocblockFixer; +use Symplify\CodingStandard\Fixer\Annotation\RemoveMethodNameDuplicateDescriptionFixer; use Symplify\CodingStandard\Fixer\ArrayNotation\ArrayListItemNewlineFixer; use Symplify\CodingStandard\Fixer\ArrayNotation\ArrayOpenerAndCloserNewlineFixer; use Symplify\CodingStandard\Fixer\Commenting\ParamReturnAndVarTagMalformsFixer; @@ -22,7 +22,7 @@ RemovePHPStormAnnotationFixer::class, ParamReturnAndVarTagMalformsFixer::class, RemoveUselessDefaultCommentFixer::class, - RemoveSetterGetterDocblockFixer::class, + RemoveMethodNameDuplicateDescriptionFixer::class, // arrays ArrayListItemNewlineFixer::class, diff --git a/src/Fixer/Annotation/RemoveSetterGetterDocblockFixer.php b/src/Fixer/Annotation/RemoveMethodNameDuplicateDescriptionFixer.php similarity index 88% rename from src/Fixer/Annotation/RemoveSetterGetterDocblockFixer.php rename to src/Fixer/Annotation/RemoveMethodNameDuplicateDescriptionFixer.php index 484b1cf2..1eab3b34 100644 --- a/src/Fixer/Annotation/RemoveSetterGetterDocblockFixer.php +++ b/src/Fixer/Annotation/RemoveMethodNameDuplicateDescriptionFixer.php @@ -15,14 +15,14 @@ use Symplify\CodingStandard\TokenRunner\Traverser\TokenReverser; /** - * @see \Symplify\CodingStandard\Tests\Fixer\Annotation\RemoveSetterGetterDocblockFixer\RemoveSetterGetterDocblockFixerTest + * @see \Symplify\CodingStandard\Tests\Fixer\Annotation\RemoveRedundantDescriptionFixer\RemoveRedundantDescriptionFixerTest */ -final class RemoveSetterGetterDocblockFixer extends AbstractSymplifyFixer +final class RemoveMethodNameDuplicateDescriptionFixer extends AbstractSymplifyFixer { /** * @var string */ - private const ERROR_MESSAGE = 'Remove setter and getter only docblocks'; + private const ERROR_MESSAGE = 'Remove docblock descriptions which duplicate their method name'; private readonly MethodNameResolver $methodNameResolver; diff --git a/tests/Fixer/Annotation/RemoveSetterGetterDocblockFixer/Fixture/simple_annotation.php.inc b/tests/Fixer/Annotation/RemoveMethodNameDuplicateDescriptionFixer/Fixture/simple_annotation.php.inc similarity index 51% rename from tests/Fixer/Annotation/RemoveSetterGetterDocblockFixer/Fixture/simple_annotation.php.inc rename to tests/Fixer/Annotation/RemoveMethodNameDuplicateDescriptionFixer/Fixture/simple_annotation.php.inc index 71c8bd67..ad496eaa 100644 --- a/tests/Fixer/Annotation/RemoveSetterGetterDocblockFixer/Fixture/simple_annotation.php.inc +++ b/tests/Fixer/Annotation/RemoveMethodNameDuplicateDescriptionFixer/Fixture/simple_annotation.php.inc @@ -1,6 +1,6 @@ rules([ - RemoveSetterGetterDocblockFixer::class, + RemoveMethodNameDuplicateDescriptionFixer::class, ]); };