doc

PHP-CS-Fixer · May 22, 2024 · 2ce9b74 · 2ce9b74
1 parent 8fcf542
commit 2ce9b74
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 7 deletions.
diff --git a/doc/rules/alias/random_api_migration.rst b/doc/rules/alias/random_api_migration.rst
@@ -22,7 +22,7 @@ Configuration
 
 Mapping between replaced functions with the new ones.
 
-Allowed types: ``list<string>``
+Allowed types: ``array``
 
 Default value: ``['getrandmax' => 'mt_getrandmax', 'rand' => 'mt_rand', 'srand' => 'mt_srand']``
 

diff --git a/doc/rules/class_notation/class_attributes_separation.rst b/doc/rules/class_notation/class_attributes_separation.rst
@@ -14,7 +14,7 @@ Configuration
 Dictionary of ``const|method|property|trait_import|case`` =>
 ``none|one|only_if_meta`` values.
 
-Allowed types: ``list<string>``
+Allowed types: ``array``
 
 Default value: ``['const' => 'one', 'method' => 'one', 'property' => 'one', 'trait_import' => 'none', 'case' => 'none']``
 

diff --git a/doc/rules/index.rst b/doc/rules/index.rst
@@ -463,6 +463,13 @@ Import
 
   Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block.
 
+Internal
+--------
+
+- `configurable_fixer_template <./internal/configurable_fixer_template.rst>`_ *(risky)*
+
+  Configurable Fixers must declare Template type.
+
 Language Construct
 ------------------
 

diff --git a/doc/rules/internal/configurable_fixer_template.rst b/doc/rules/internal/configurable_fixer_template.rst
@@ -0,0 +1,22 @@
+====================================
+Rule ``configurable_fixer_template``
+====================================
+
+Configurable Fixers must declare Template type.
+
+Examples
+--------
+
+Example #1
+~~~~~~~~~~
+
+.. code-block:: diff
+
+   
+References
+----------
+
+- Fixer class: `PhpCsFixer\\Fixer\\Internal\\ConfigurableFixerTemplateFixer <./../../../src/Fixer/Internal/ConfigurableFixerTemplateFixer.php>`_
+- Test class: `PhpCsFixer\\Tests\\Fixer\\Internal\\ConfigurableFixerTemplateFixerTest <./../../../tests/Fixer/Internal/ConfigurableFixerTemplateFixerTest.php>`_
+
+The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.
diff --git a/doc/rules/phpdoc/general_phpdoc_tag_rename.rst b/doc/rules/phpdoc/general_phpdoc_tag_rename.rst
@@ -39,7 +39,7 @@ Default value: ``true``
 
 A map of tags to replace.
 
-Allowed types: ``list<string>``
+Allowed types: ``array``
 
 Default value: ``[]``
 

diff --git a/doc/rules/phpdoc/phpdoc_align.rst b/doc/rules/phpdoc/phpdoc_align.rst
@@ -27,7 +27,7 @@ spacingForB]``. If you want to define default spacing to more than 1 space use
 ``_default`` key in config array, e.g.: ``['tagA' => spacingForA, 'tagB' =>
 spacingForB, '_default' => spacingForAllOthers]``.
 
-Allowed types: ``int`` and ``list<int>``
+Allowed types: ``int`` and ``array``
 
 Default value: ``1``
 

diff --git a/doc/rules/phpdoc/phpdoc_return_self_reference.rst b/doc/rules/phpdoc/phpdoc_return_self_reference.rst
@@ -13,7 +13,7 @@ Configuration
 
 Mapping between replaced return types with new ones.
 
-Allowed types: ``list<string>``
+Allowed types: ``array``
 
 Default value: ``['this' => '$this', '@this' => '$this', '$self' => 'self', '@self' => 'self', '$static' => 'static', '@static' => 'static']``
 

diff --git a/doc/rules/phpdoc/phpdoc_separation.rst b/doc/rules/phpdoc/phpdoc_separation.rst
@@ -15,7 +15,7 @@ Configuration
 Sets of annotation types to be grouped together. Use ``*`` to match any tag
 character.
 
-Allowed types: ``list<string[]>``
+Allowed types: ``list<list<string>>``
 
 Default value: ``[['author', 'copyright', 'license'], ['category', 'package', 'subpackage'], ['property', 'property-read', 'property-write'], ['deprecated', 'link', 'see', 'since']]``
 

diff --git a/doc/rules/phpdoc/phpdoc_tag_type.rst b/doc/rules/phpdoc/phpdoc_tag_type.rst
@@ -12,7 +12,7 @@ Configuration
 
 The list of tags to fix.
 
-Allowed types: ``list<string>``
+Allowed types: ``array``
 
 Default value: ``['api' => 'annotation', 'author' => 'annotation', 'copyright' => 'annotation', 'deprecated' => 'annotation', 'example' => 'annotation', 'global' => 'annotation', 'inheritDoc' => 'annotation', 'internal' => 'annotation', 'license' => 'annotation', 'method' => 'annotation', 'package' => 'annotation', 'param' => 'annotation', 'property' => 'annotation', 'return' => 'annotation', 'see' => 'annotation', 'since' => 'annotation', 'throws' => 'annotation', 'todo' => 'annotation', 'uses' => 'annotation', 'var' => 'annotation', 'version' => 'annotation']``