Renames PHPDoc tags.
Whether annotation tags should be fixed.
Allowed types: bool
Default value: true
Whether inline tags should be fixed.
Allowed types: bool
Default value: true
A map of tags to replace.
Allowed types: array
Default value: []
Whether tags should be replaced only if they have exact same casing.
Allowed types: bool
Default value: false
With configuration: ['replacements' => ['inheritDocs' => 'inheritDoc']]
.
--- Original
+++ New
<?php
/**
- * @inheritDocs
- * {@inheritdocs}
+ * @inheritDoc
+ * {@inheritDoc}
*/
With configuration: ['replacements' => ['inheritDocs' => 'inheritDoc'], 'fix_annotation' => false]
.
--- Original
+++ New
<?php
/**
* @inheritDocs
- * {@inheritdocs}
+ * {@inheritDoc}
*/
With configuration: ['replacements' => ['inheritDocs' => 'inheritDoc'], 'fix_inline' => false]
.
--- Original
+++ New
<?php
/**
- * @inheritDocs
+ * @inheritDoc
* {@inheritdocs}
*/
With configuration: ['replacements' => ['inheritDocs' => 'inheritDoc'], 'case_sensitive' => true]
.
--- Original
+++ New
<?php
/**
- * @inheritDocs
+ * @inheritDoc
* {@inheritdocs}
*/
The rule is part of the following rule sets:
- @PhpCsFixer
Using the @PhpCsFixer rule set will enable the
general_phpdoc_tag_rename
rule with the config below:['replacements' => ['inheritDocs' => 'inheritDoc']]
- @Symfony
Using the @Symfony rule set will enable the
general_phpdoc_tag_rename
rule with the config below:['replacements' => ['inheritDocs' => 'inheritDoc']]