docs: Sort options in documentation (#7345)

doc/rules/basic/braces.rst

@@ -37,16 +37,15 @@ Allowed types: ``bool``
 
 Default value: ``false``
 
-``position_after_functions_and_oop_constructs``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``position_after_anonymous_constructs``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Whether the opening brace should be placed on "next" or "same" line after classy
-constructs (non-anonymous classes, interfaces, traits, methods and non-lambda
-functions).
+Whether the opening brace should be placed on "next" or "same" line after
+anonymous constructs (anonymous classes and lambda functions).
 
 Allowed values: ``'next'`` and ``'same'``
 
-Default value: ``'next'``
+Default value: ``'same'``
 
 ``position_after_control_structures``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -58,15 +57,16 @@ Allowed values: ``'next'`` and ``'same'``
 
 Default value: ``'same'``
 
-``position_after_anonymous_constructs``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``position_after_functions_and_oop_constructs``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Whether the opening brace should be placed on "next" or "same" line after
-anonymous constructs (anonymous classes and lambda functions).
+Whether the opening brace should be placed on "next" or "same" line after classy
+constructs (non-anonymous classes, interfaces, traits, methods and non-lambda
+functions).
 
 Allowed values: ``'next'`` and ``'same'``
 
-Default value: ``'same'``
+Default value: ``'next'``
 
 Examples
 --------

doc/rules/basic/braces_position.rst

@@ -7,23 +7,32 @@ Braces must be placed as configured.
 Configuration
 -------------
 
-``control_structures_opening_brace``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``allow_single_line_anonymous_functions``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The position of the opening brace of control structures‘ body.
+Allow anonymous functions to have opening and closing braces on the same line.
 
-Allowed values: ``'next_line_unless_newline_at_signature_end'`` and ``'same_line'``
+Allowed types: ``bool``
 
-Default value: ``'same_line'``
+Default value: ``true``
 
-``functions_opening_brace``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``allow_single_line_empty_anonymous_classes``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The position of the opening brace of functions‘ body.
+Allow anonymous classes to have opening and closing braces on the same line.
+
+Allowed types: ``bool``
+
+Default value: ``true``
+
+``anonymous_classes_opening_brace``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The position of the opening brace of anonymous classes‘ body.
 
 Allowed values: ``'next_line_unless_newline_at_signature_end'`` and ``'same_line'``
 
-Default value: ``'next_line_unless_newline_at_signature_end'``
+Default value: ``'same_line'``
 
 ``anonymous_functions_opening_brace``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -43,32 +52,23 @@ Allowed values: ``'next_line_unless_newline_at_signature_end'`` and ``'same_line
 
 Default value: ``'next_line_unless_newline_at_signature_end'``
 
-``anonymous_classes_opening_brace``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``control_structures_opening_brace``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The position of the opening brace of anonymous classes‘ body.
+The position of the opening brace of control structures‘ body.
 
 Allowed values: ``'next_line_unless_newline_at_signature_end'`` and ``'same_line'``
 
 Default value: ``'same_line'``
 
-``allow_single_line_empty_anonymous_classes``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Allow anonymous classes to have opening and closing braces on the same line.
-
-Allowed types: ``bool``
-
-Default value: ``true``
-
-``allow_single_line_anonymous_functions``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``functions_opening_brace``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Allow anonymous functions to have opening and closing braces on the same line.
+The position of the opening brace of functions‘ body.
 
-Allowed types: ``bool``
+Allowed values: ``'next_line_unless_newline_at_signature_end'`` and ``'same_line'``
 
-Default value: ``true``
+Default value: ``'next_line_unless_newline_at_signature_end'``
 
 Examples
 --------

doc/rules/basic/curly_braces_position.rst

@@ -15,23 +15,32 @@ You should use ``braces_position`` instead.
 Configuration
 -------------
 
-``control_structures_opening_brace``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``allow_single_line_anonymous_functions``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The position of the opening brace of control structures‘ body.
+Allow anonymous functions to have opening and closing braces on the same line.
 
-Allowed values: ``'next_line_unless_newline_at_signature_end'`` and ``'same_line'``
+Allowed types: ``bool``
 
-Default value: ``'same_line'``
+Default value: ``true``
 
-``functions_opening_brace``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``allow_single_line_empty_anonymous_classes``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The position of the opening brace of functions‘ body.
+Allow anonymous classes to have opening and closing braces on the same line.
+
+Allowed types: ``bool``
+
+Default value: ``true``
+
+``anonymous_classes_opening_brace``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The position of the opening brace of anonymous classes‘ body.
 
 Allowed values: ``'next_line_unless_newline_at_signature_end'`` and ``'same_line'``
 
-Default value: ``'next_line_unless_newline_at_signature_end'``
+Default value: ``'same_line'``
 
 ``anonymous_functions_opening_brace``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -51,32 +60,23 @@ Allowed values: ``'next_line_unless_newline_at_signature_end'`` and ``'same_line
 
 Default value: ``'next_line_unless_newline_at_signature_end'``
 
-``anonymous_classes_opening_brace``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``control_structures_opening_brace``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The position of the opening brace of anonymous classes‘ body.
+The position of the opening brace of control structures‘ body.
 
 Allowed values: ``'next_line_unless_newline_at_signature_end'`` and ``'same_line'``
 
 Default value: ``'same_line'``
 
-``allow_single_line_empty_anonymous_classes``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Allow anonymous classes to have opening and closing braces on the same line.
-
-Allowed types: ``bool``
-
-Default value: ``true``
-
-``allow_single_line_anonymous_functions``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``functions_opening_brace``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Allow anonymous functions to have opening and closing braces on the same line.
+The position of the opening brace of functions‘ body.
 
-Allowed types: ``bool``
+Allowed values: ``'next_line_unless_newline_at_signature_end'`` and ``'same_line'``
 
-Default value: ``true``
+Default value: ``'next_line_unless_newline_at_signature_end'``
 
 Examples
 --------

doc/rules/class_notation/class_definition.rst

@@ -8,6 +8,15 @@ should be one space.
 Configuration
 -------------
 
+``inline_constructor_arguments``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Whether constructor argument list in anonymous classes should be single line.
+
+Allowed types: ``bool``
+
+Default value: ``true``
+
 ``multi_line_extends_each_single_line``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -45,15 +54,6 @@ Allowed types: ``bool``
 
 Default value: ``false``
 
-``inline_constructor_arguments``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Whether constructor argument list in anonymous classes should be single line.
-
-Allowed types: ``bool``
-
-Default value: ``true``
-
 Examples
 --------
 

doc/rules/class_notation/final_internal_class.rst

@@ -15,18 +15,6 @@ Changing classes to ``final`` might cause code execution to break.
 Configuration
 -------------
 
-``annotation_include``
-~~~~~~~~~~~~~~~~~~~~~~
-
-.. warning:: This option is deprecated and will be removed in the next major version. Use ``include`` to configure PHPDoc annotations tags and attributes.
-
-Class level attribute or annotation tags that must be set in order to fix the
-class (case insensitive).
-
-Allowed types: ``array``
-
-Default value: ``['@internal']``
-
 ``annotation_exclude``
 ~~~~~~~~~~~~~~~~~~~~~~
 
@@ -39,15 +27,26 @@ Allowed types: ``array``
 
 Default value: ``['@final', '@Entity', '@ORM\\Entity', '@ORM\\Mapping\\Entity', '@Mapping\\Entity', '@Document', '@ODM\\Document']``
 
-``include``
-~~~~~~~~~~~
+``annotation_include``
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. warning:: This option is deprecated and will be removed in the next major version. Use ``include`` to configure PHPDoc annotations tags and attributes.
 
 Class level attribute or annotation tags that must be set in order to fix the
 class (case insensitive).
 
 Allowed types: ``array``
 
-Default value: ``['internal']``
+Default value: ``['@internal']``
+
+``consider_absent_docblock_as_internal_class``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Whether classes without any DocBlock should be fixed to final.
+
+Allowed types: ``bool``
+
+Default value: ``false``
 
 ``exclude``
 ~~~~~~~~~~~
@@ -59,14 +58,15 @@ Allowed types: ``array``
 
 Default value: ``['final', 'Entity', 'ORM\\Entity', 'ORM\\Mapping\\Entity', 'Mapping\\Entity', 'Document', 'ODM\\Document']``
 
-``consider_absent_docblock_as_internal_class``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``include``
+~~~~~~~~~~~
 
-Whether classes without any DocBlock should be fixed to final.
+Class level attribute or annotation tags that must be set in order to fix the
+class (case insensitive).
 
-Allowed types: ``bool``
+Allowed types: ``array``
 
-Default value: ``false``
+Default value: ``['internal']``
 
 Examples
 --------

doc/rules/class_notation/ordered_class_elements.rst

@@ -32,6 +32,15 @@ the order of that specific method.
 Configuration
 -------------
 
+``case_sensitive``
+~~~~~~~~~~~~~~~~~~
+
+Whether the sorting should be case sensitive.
+
+Allowed types: ``bool``
+
+Default value: ``false``
+
 ``order``
 ~~~~~~~~~
 
@@ -50,15 +59,6 @@ Allowed values: ``'alpha'`` and ``'none'``
 
 Default value: ``'none'``
 
-``case_sensitive``
-~~~~~~~~~~~~~~~~~~
-
-Whether the sorting should be case sensitive.
-
-Allowed types: ``bool``
-
-Default value: ``false``
-
 Examples
 --------
 

doc/rules/class_notation/ordered_interfaces.rst

@@ -7,14 +7,14 @@ Orders the interfaces in an ``implements`` or ``interface extends`` clause.
 Configuration
 -------------
 
-``order``
-~~~~~~~~~
+``case_sensitive``
+~~~~~~~~~~~~~~~~~~
 
-How the interfaces should be ordered.
+Whether the sorting should be case sensitive.
 
-Allowed values: ``'alpha'`` and ``'length'``
+Allowed types: ``bool``
 
-Default value: ``'alpha'``
+Default value: ``false``
 
 ``direction``
 ~~~~~~~~~~~~~
@@ -25,14 +25,14 @@ Allowed values: ``'ascend'`` and ``'descend'``
 
 Default value: ``'ascend'``
 
-``case_sensitive``
-~~~~~~~~~~~~~~~~~~
+``order``
+~~~~~~~~~
 
-Whether the sorting should be case sensitive.
+How the interfaces should be ordered.
 
-Allowed types: ``bool``
+Allowed values: ``'alpha'`` and ``'length'``
 
-Default value: ``false``
+Default value: ``'alpha'``
 
 Examples
 --------