Merge pull request #26 from DanielSiepmann/feature/25-make-phpdoctags-configurable
FEATURE: Make PHPDoc tags configurable
This commit is contained in:
commit
e98c52fbd9
3 changed files with 19 additions and 1 deletions
13
Readme.rst
13
Readme.rst
|
@ -119,3 +119,16 @@ the provided one.
|
||||||
<property name="legacyExtensions" type="array" value="Extbase,Fluid,Frontend,Core"/>
|
<property name="legacyExtensions" type="array" value="Extbase,Fluid,Frontend,Core"/>
|
||||||
</properties>
|
</properties>
|
||||||
</rule>
|
</rule>
|
||||||
|
|
||||||
|
Typo3Update.LegacyClassnames.DocComment: ``allowedTags``
|
||||||
|
Configures which tags are checked for legacy class names.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
.. code:: xml
|
||||||
|
|
||||||
|
<rule ref="Typo3Update.LegacyClassnames.DocComment">
|
||||||
|
<properties>
|
||||||
|
<property name="allowedTags" type="array" value="@param,@return,@var,@see,@throws"/>
|
||||||
|
</properties>
|
||||||
|
</rule>
|
||||||
|
|
|
@ -32,7 +32,7 @@ class Typo3Update_Sniffs_LegacyClassnames_DocCommentSniff implements PHP_CodeSni
|
||||||
* The configured tags will be processed.
|
* The configured tags will be processed.
|
||||||
* @var array<string>
|
* @var array<string>
|
||||||
*/
|
*/
|
||||||
protected $allowedTags = ['@param', '@return', '@var'];
|
public $allowedTags = ['@param', '@return', '@var'];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Original token content for reuse accross methods.
|
* Original token content for reuse accross methods.
|
||||||
|
|
|
@ -7,4 +7,9 @@
|
||||||
<property name="legacyExtensions" type="array" value="Extbase,Fluid,Frontend,Core"/>
|
<property name="legacyExtensions" type="array" value="Extbase,Fluid,Frontend,Core"/>
|
||||||
</properties>
|
</properties>
|
||||||
</rule>
|
</rule>
|
||||||
|
<rule ref="Typo3Update.LegacyClassnames.DocComment">
|
||||||
|
<properties>
|
||||||
|
<property name="allowedTags" type="array" value="@param,@return,@var,@see,@throws"/>
|
||||||
|
</properties>
|
||||||
|
</rule>
|
||||||
</ruleset>
|
</ruleset>
|
||||||
|
|
Loading…
Reference in a new issue