• Install now

Rule phpdoc_inline_tag_normalizer

Fixes PHPDoc inline tags.

Configuration

tags

The list of tags to normalize.

Allowed types: list<string>

Default value: ['example', 'id', 'internal', 'inheritdoc', 'inheritdocs', 'link', 'source', 'toc', 'tutorial']

Examples

Example #1

Default configuration.

--- Original
+++ New
 <?php
 /**
- * @{TUTORIAL}
- * {{ @link }}
+ * {@TUTORIAL}
+ * {@link}
  * @inheritDoc
  */

Example #2

With configuration: ['tags' => ['TUTORIAL']].

--- Original
+++ New
 <?php
 /**
- * @{TUTORIAL}
+ * {@TUTORIAL}
  * {{ @link }}
  * @inheritDoc
  */

Rule sets

The rule is part of the following rule sets:

• @PhpCsFixer

• @Symfony

References

• Fixer class: PhpCsFixer\Fixer\Phpdoc\PhpdocInlineTagNormalizerFixer

• Test class: PhpCsFixer\Tests\Fixer\Phpdoc\PhpdocInlineTagNormalizerFixerTest

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