minor #5223 Docs: regenerate docs on 2.16 line (keradus)

This PR was merged into the 2.16 branch.

Discussion
----------

Docs: regenerate docs on 2.16 line

Commits
-------

7614822 Docs: regenerate docs on 2.16 line

Author: keradus

doc/rules/casing/constant_case.rst

@@ -0,0 +1,70 @@
+======================
+Rule ``constant_case``
+======================
+
+The PHP constants ``true``, ``false``, and ``null`` MUST be written using the
+correct casing.
+
+Configuration
+-------------
+
+``case``
+~~~~~~~~
+
+Whether to use the ``upper`` or ``lower`` case syntax.
+
+Allowed values: ``'lower'``, ``'upper'``
+
+Default value: ``'lower'``
+
+Examples
+--------
+
+Example #1
+~~~~~~~~~~
+
+*Default* configuration.
+
+.. code-block:: diff
+
+   --- Original
+   +++ New
+   @@ -1,4 +1,4 @@
+    <?php
+   -$a = FALSE;
+   -$b = True;
+   -$c = nuLL;
+   +$a = false;
+   +$b = true;
+   +$c = null;
+
+Example #2
+~~~~~~~~~~
+
+With configuration: ``['case' => 'upper']``.
+
+.. code-block:: diff
+
+   --- Original
+   +++ New
+   @@ -1,4 +1,4 @@
+    <?php
+    $a = FALSE;
+   -$b = True;
+   -$c = nuLL;
+   +$b = TRUE;
+   +$c = NULL;
+
+Rule sets
+---------
+
+The rule is part of the following rule sets:
+
+@PSR2
+  Using the ``@PSR2`` rule set will enable the ``constant_case`` rule with the default config.
+
+@Symfony
+  Using the ``@Symfony`` rule set will enable the ``constant_case`` rule with the default config.
+
+@PhpCsFixer
+  Using the ``@PhpCsFixer`` rule set will enable the ``constant_case`` rule with the default config.

doc/rules/casing/lowercase_constants.rst

@@ -2,6 +2,10 @@
 Rule ``lowercase_constants``
 ============================
 
+.. warning:: This rule is deprecated and will be removed on next major version.
+
+   You should use ``constant_case`` instead.
+
 The PHP constants ``true``, ``false``, and ``null`` MUST be in lower case.
 
 Examples
@@ -22,17 +26,3 @@ Example #1
    +$a = false;
    +$b = true;
    +$c = null;
-
-Rule sets
----------
-
-The rule is part of the following rule sets:
-
-@PSR2
-  Using the ``@PSR2`` rule set will enable the ``lowercase_constants`` rule.
-
-@Symfony
-  Using the ``@Symfony`` rule set will enable the ``lowercase_constants`` rule.
-
-@PhpCsFixer
-  Using the ``@PhpCsFixer`` rule set will enable the ``lowercase_constants`` rule.

doc/rules/class_notation/final_public_method_for_abstract_class.rst

@@ -0,0 +1,34 @@
+===============================================
+Rule ``final_public_method_for_abstract_class``
+===============================================
+
+All ``public`` methods of ``abstract`` classes should be ``final``.
+
+Description
+-----------
+
+Enforce API encapsulation in an inheritance architecture. If you want to
+override a method, use the Template method pattern.
+
+.. warning:: Using this rule is risky.
+
+   Risky when overriding ``public`` methods of ``abstract`` classes.
+
+Examples
+--------
+
+Example #1
+~~~~~~~~~~
+
+.. code-block:: diff
+
+   --- Original
+   +++ New
+   @@ -2,6 +2,6 @@
+
+    abstract class AbstractMachine
+    {
+   -    public function start()
+   +    final public function start()
+        {}
+    }

doc/rules/class_notation/final_static_access.rst

@@ -0,0 +1,24 @@
+============================
+Rule ``final_static_access``
+============================
+
+Converts ``static`` access to ``self`` access in ``final`` classes.
+
+Examples
+--------
+
+Example #1
+~~~~~~~~~~
+
+.. code-block:: diff
+
+   --- Original
+   +++ New
+   @@ -3,6 +3,6 @@
+    {
+        public function getFoo()
+        {
+   -        return static::class;
+   +        return self::class;
+        }
+    }

doc/rules/class_notation/self_static_accessor.rst

@@ -0,0 +1,72 @@
+=============================
+Rule ``self_static_accessor``
+=============================
+
+Inside a ``final`` class or anonymous class ``self`` should be preferred to
+``static``.
+
+Examples
+--------
+
+Example #1
+~~~~~~~~~~
+
+.. code-block:: diff
+
+   --- Original
+   +++ New
+   @@ -5,6 +5,6 @@
+
+        public function getBar()
+        {
+   -        return static::class.static::test().static::$A;
+   +        return self::class.self::test().self::$A;
+        }
+
+Example #2
+~~~~~~~~~~
+
+.. code-block:: diff
+
+   --- Original
+   +++ New
+   @@ -3,6 +3,6 @@
+    {
+        public function bar()
+        {
+   -        return new static();
+   +        return new self();
+        }
+    }
+
+Example #3
+~~~~~~~~~~
+
+.. code-block:: diff
+
+   --- Original
+   +++ New
+   @@ -3,6 +3,6 @@
+    {
+        public function isBar()
+        {
+   -        return $foo instanceof static;
+   +        return $foo instanceof self;
+        }
+    }
+
+Example #4
+~~~~~~~~~~
+
+.. code-block:: diff
+
+   --- Original
+   +++ New
+   @@ -2,6 +2,6 @@
+    $a = new class() {
+        public function getBar()
+        {
+   -        return static::class;
+   +        return self::class;
+        }
+    };

doc/rules/comment/comment_to_phpdoc.rst

@@ -9,12 +9,26 @@ Comments with annotation should be docblock when used on structural elements.
    Risky as new docblocks might mean more, e.g. a Doctrine entity might have a
    new column in database.
 
+Configuration
+-------------
+
+``ignored_tags``
+~~~~~~~~~~~~~~~~
+
+List of ignored tags
+
+Allowed types: ``array``
+
+Default value: ``[]``
+
 Examples
 --------
 
 Example #1
 ~~~~~~~~~~
 
+*Default* configuration.
+
 .. code-block:: diff
 
    --- Original
@@ -23,10 +37,27 @@ Example #1
    -<?php /* header */ $x = true; /* @var bool $isFoo */ $isFoo = true;
    +<?php /* header */ $x = true; /** @var bool $isFoo */ $isFoo = true;
 
+Example #2
+~~~~~~~~~~
+
+With configuration: ``['ignored_tags' => ['todo']]``.
+
+.. code-block:: diff
+
+   --- Original
+   +++ New
+   @@ -2,5 +2,5 @@
+    // @todo do something later
+    $foo = 1;
+
+   -// @var int $a
+   +/** @var int $a */
+    $a = foo();
+
 Rule sets
 ---------
 
 The rule is part of the following rule set:
 
 @PhpCsFixer:risky
-  Using the ``@PhpCsFixer:risky`` rule set will enable the ``comment_to_phpdoc`` rule.
+  Using the ``@PhpCsFixer:risky`` rule set will enable the ``comment_to_phpdoc`` rule with the default config.

doc/rules/function_notation/nullable_type_declaration_for_default_null_value.rst

@@ -0,0 +1,57 @@
+=========================================================
+Rule ``nullable_type_declaration_for_default_null_value``
+=========================================================
+
+Adds or removes ``?`` before type declarations for parameters with a default
+``null`` value.
+
+Description
+-----------
+
+Rule is applied only in a PHP 7.1+ environment.
+
+Configuration
+-------------
+
+``use_nullable_type_declaration``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Whether to add or remove ``?`` before type declarations for parameters with a
+default ``null`` value.
+
+Allowed types: ``bool``
+
+Default value: ``true``
+
+Examples
+--------
+
+Example #1
+~~~~~~~~~~
+
+*Default* configuration.
+
+.. code-block:: diff
+
+   --- Original
+   +++ New
+   @@ -1,3 +1,3 @@
+    <?php
+   -function sample(string $str = null)
+   +function sample(?string $str = null)
+    {}
+
+Example #2
+~~~~~~~~~~
+
+With configuration: ``['use_nullable_type_declaration' => false]``.
+
+.. code-block:: diff
+
+   --- Original
+   +++ New
+   @@ -1,3 +1,3 @@
+    <?php
+   -function sample(?string $str = null)
+   +function sample(string $str = null)
+    {}

doc/rules/function_notation/phpdoc_to_param_type.rst

@@ -0,0 +1,47 @@
+=============================
+Rule ``phpdoc_to_param_type``
+=============================
+
+EXPERIMENTAL: Takes ``@param`` annotations of non-mixed types and adjusts
+accordingly the function signature. Requires PHP >= 7.0.
+
+.. warning:: Using this rule is risky.
+
+   This rule is EXPERIMENTAL and [1] is not covered with backward compatibility
+   promise. [2] ``@param`` annotation is mandatory for the fixer to make
+   changes, signatures of methods without it (no docblock, inheritdocs) will not
+   be fixed. [3] Manual actions are required if inherited signatures are not
+   properly documented.
+
+Examples
+--------
+
+Example #1
+~~~~~~~~~~
+
+.. code-block:: diff
+
+   --- Original
+   +++ New
+   @@ -1,5 +1,5 @@
+    <?php
+
+    /** @param string $bar */
+   -function my_foo($bar)
+   +function my_foo(string $bar)
+    {}
+
+Example #2
+~~~~~~~~~~
+
+.. code-block:: diff
+
+   --- Original
+   +++ New
+   @@ -1,5 +1,5 @@
+    <?php
+
+    /** @param string|null $bar */
+   -function my_foo($bar)
+   +function my_foo(?string $bar)
+    {}