TASK: Update docs

* To keep naming in sync with code, to make examples work.
This commit is contained in:
Daniel Siepmann 2017-04-25 15:36:20 +02:00
parent 22d50486cf
commit 28329844b8
Signed by: Daniel Siepmann
GPG key ID: 33D6629915560EF4

View file

@ -28,13 +28,13 @@ Configures which extension names are legacy. Used to provide further checks and
possible legacy code. All class usages starting with ``Tx_<ExtensionName>`` where ExtensionName is possible legacy code. All class usages starting with ``Tx_<ExtensionName>`` where ExtensionName is
defined in this array, will produce a warning, until the class is already found to be deprecaed. defined in this array, will produce a warning, until the class is already found to be deprecaed.
Can and have to be configured for each sniff, e.g. ``Instanceof`` and ``DocComment``. Can and have to be configured for each sniff, e.g. ``Instanceof`` and ``PhpDocComment``.
Example: Example:
.. code:: xml .. code:: xml
<rule ref="Typo3Update.LegacyClassnames.Instanceof"> <rule ref="Typo3Update.Classname.Instanceof">
<properties> <properties>
<property name="legacyExtensions" type="array" value="Extbase,Fluid,Frontend,Core"/> <property name="legacyExtensions" type="array" value="Extbase,Fluid,Frontend,Core"/>
</properties> </properties>
@ -46,7 +46,7 @@ Example:
allowedTags allowedTags
----------- -----------
Only used inside Sniff ``Typo3Update.LegacyClassnames.DocComment``. Only used inside Sniff ``Typo3Update.Classname.PhpDocComment``.
Configures which tags are checked for legacy class names. Configures which tags are checked for legacy class names.
@ -57,7 +57,7 @@ Example:
.. code:: xml .. code:: xml
<rule ref="Typo3Update.LegacyClassnames.DocComment"> <rule ref="Typo3Update.Classname.PhpDocComment">
<properties> <properties>
<property name="allowedTags" type="array" value="@param,@return,@var,@see,@throws"/> <property name="allowedTags" type="array" value="@param,@return,@var,@see,@throws"/>
</properties> </properties>