phpdoc_no_useless_inheritdoc.rst

Rule phpdoc_no_useless_inheritdoc

Classy that does not inherit must not have @inheritdoc tags.

Examples

Example #1

--- Original
+++ New
 <?php
-/** {@inheritdoc} */
+/** */
 class Sample
 {
 }

Example #2

--- Original
+++ New
 <?php
 class Sample
 {
     /**
-     * @inheritdoc
+     *
      */
     public function Test()
     {
     }
 }

Rule sets

The rule is part of the following rule sets:

• @PhpCsFixer
• @Symfony

References

• Fixer class: PhpCsFixer\Fixer\Phpdoc\PhpdocNoUselessInheritdocFixer
• Test class: PhpCsFixer\Tests\Fixer\Phpdoc\PhpdocNoUselessInheritdocFixerTest

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