Issue #13666: final fix for ordering of properties in modules

checkstyle · Sep 29, 2023 · a69c482 · a69c482
1 parent 2ab52c6
commit a69c482
Show file tree

Hide file tree

Showing 25 changed files with 297 additions and 313 deletions.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/DescendantTokenCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/DescendantTokenCheck.java
@@ -49,30 +49,25 @@
  * Default value is {@code ""}.
  * </li>
  * <li>
- * Property {@code minimumDepth} - Specify the minimum depth for descendant counts.
- * Type is {@code int}.
- * Default value is {@code 0}.
- * </li>
- * <li>
  * Property {@code maximumDepth} - Specify the maximum depth for descendant counts.
  * Type is {@code int}.
  * Default value is {@code 2147483647}.
  * </li>
  * <li>
- * Property {@code minimumNumber} - Specify a minimum count for descendants.
- * Type is {@code int}.
- * Default value is {@code 0}.
+ * Property {@code maximumMessage} - Define the violation message
+ * when the maximum count is exceeded.
+ * Type is {@code java.lang.String}.
+ * Default value is {@code null}.
  * </li>
  * <li>
  * Property {@code maximumNumber} - Specify a maximum count for descendants.
  * Type is {@code int}.
  * Default value is {@code 2147483647}.
  * </li>
  * <li>
- * Property {@code sumTokenCounts} - Control whether the number of tokens found
- * should be calculated from the sum of the individual token counts.
- * Type is {@code boolean}.
- * Default value is {@code false}.
+ * Property {@code minimumDepth} - Specify the minimum depth for descendant counts.
+ * Type is {@code int}.
+ * Default value is {@code 0}.
  * </li>
  * <li>
  * Property {@code minimumMessage} - Define the violation message
@@ -81,10 +76,15 @@
  * Default value is {@code null}.
  * </li>
  * <li>
- * Property {@code maximumMessage} - Define the violation message
- * when the maximum count is exceeded.
- * Type is {@code java.lang.String}.
- * Default value is {@code null}.
+ * Property {@code minimumNumber} - Specify a minimum count for descendants.
+ * Type is {@code int}.
+ * Default value is {@code 0}.
+ * </li>
+ * <li>
+ * Property {@code sumTokenCounts} - Control whether the number of tokens found
+ * should be calculated from the sum of the individual token counts.
+ * Type is {@code boolean}.
+ * Default value is {@code false}.
  * </li>
  * <li>
  * Property {@code tokens} - tokens to check

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/NewlineAtEndOfFileCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/NewlineAtEndOfFileCheck.java
@@ -74,15 +74,15 @@
  * </p>
  * <ul>
  * <li>
- * Property {@code lineSeparator} - Specify the type of line separator.
- * Type is {@code com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption}.
- * Default value is {@code lf_cr_crlf}.
- * </li>
- * <li>
  * Property {@code fileExtensions} - Specify the file type extension of the files to check.
  * Type is {@code java.lang.String[]}.
  * Default value is {@code ""}.
  * </li>
+ * <li>
+ * Property {@code lineSeparator} - Specify the type of line separator.
+ * Type is {@code com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption}.
+ * Default value is {@code lf_cr_crlf}.
+ * </li>
  * </ul>
  * <p>
  * Parent is {@code com.puppycrawl.tools.checkstyle.Checker}

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SingleLineJavadocCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SingleLineJavadocCheck.java
@@ -35,11 +35,11 @@
  * </p>
  * <ul>
  * <li>
- * Property {@code violateExecutionOnNonTightHtml} - Control when to print violations
- * if the Javadoc being examined by this check violates the tight html rules defined at
- * <a href="https://checkstyle.org/writingjavadocchecks.html#Tight-HTML_rules">Tight-HTML Rules</a>.
+ * Property {@code ignoreInlineTags} - Control whether
+ * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBEFIF">
+ * inline tags</a> must be ignored.
  * Type is {@code boolean}.
- * Default value is {@code false}.
+ * Default value is {@code true}.
  * </li>
  * <li>
  * Property {@code ignoredTags} - Specify
@@ -49,11 +49,11 @@
  * Default value is {@code ""}.
  * </li>
  * <li>
- * Property {@code ignoreInlineTags} - Control whether
- * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBEFIF">
- * inline tags</a> must be ignored.
+ * Property {@code violateExecutionOnNonTightHtml} - Control when to print violations
+ * if the Javadoc being examined by this check violates the tight html rules defined at
+ * <a href="https://checkstyle.org/writingjavadocchecks.html#Tight-HTML_rules">Tight-HTML Rules</a>.
  * Type is {@code boolean}.
- * Default value is {@code true}.
+ * Default value is {@code false}.
  * </li>
  * </ul>
  * <p>

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpOnFilenameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpOnFilenameCheck.java
@@ -72,33 +72,29 @@
  * </p>
  * <ul>
  * <li>
- * Property {@code folderPattern} - Specify the regular expression to match the folder path against.
- * Type is {@code java.util.regex.Pattern}.
- * Default value is {@code null}.</li>
- *
+ * Property {@code fileExtensions} - Specify the file type extension of files to process. If this is
+ * specified, then only files that match these types are examined with the other
+ * patterns.
+ * Type is {@code java.lang.String[]}.
+ * Default value is {@code ""}.</li>
  * <li>
  * Property {@code fileNamePattern} - Specify the regular expression to match the file name against.
  * Type is {@code java.util.regex.Pattern}.
  * Default value is {@code null}.</li>
- *
  * <li>
- * Property {@code match} - Control whether to look for a match or mismatch on the file name, if
- * the fileNamePattern is supplied, otherwise it is applied on the folderPattern.
- * Type is {@code boolean}.
- * Default value is {@code true}.</li>
- *
+ * Property {@code folderPattern} - Specify the regular expression to match the folder path against.
+ * Type is {@code java.util.regex.Pattern}.
+ * Default value is {@code null}.</li>
  * <li>
  * Property {@code ignoreFileNameExtensions} - Control whether to ignore the file extension for
  * the file name match.
  * Type is {@code boolean}.
  * Default value is {@code false}.</li>
- *
  * <li>
- * Property {@code fileExtensions} - Specify the file type extension of files to process. If this is
- * specified, then only files that match these types are examined with the other
- * patterns.
- * Type is {@code java.lang.String[]}.
- * Default value is {@code ""}.</li>
+ * Property {@code match} - Control whether to look for a match or mismatch on the file name, if
+ * the fileNamePattern is supplied, otherwise it is applied on the folderPattern.
+ * Type is {@code boolean}.
+ * Default value is {@code true}.</li>
  * </ul>
  * <p>
  * Parent is {@code com.puppycrawl.tools.checkstyle.Checker}

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpSinglelineCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpSinglelineCheck.java
@@ -38,35 +38,35 @@
  * </p>
  * <ul>
  * <li>
+ * Property {@code fileExtensions} - Specify the file type extension of files to process.
+ * Type is {@code java.lang.String[]}.
+ * Default value is {@code ""}.
+ * </li>
+ * <li>
  * Property {@code format} - Specify the format of the regular expression to match.
  * Type is {@code java.util.regex.Pattern}.
  * Default value is {@code "$."}.
  * </li>
  * <li>
- * Property {@code message} - Specify the message which is used to notify about
- * violations, if empty then default (hard-coded) message is used.
- * Type is {@code java.lang.String}.
- * Default value is {@code null}.
- * </li>
- * <li>
  * Property {@code ignoreCase} - Control whether to ignore case when searching.
  * Type is {@code boolean}.
  * Default value is {@code false}.
  * </li>
  * <li>
- * Property {@code minimum} - Specify the minimum number of matches required in each file.
+ * Property {@code maximum} - Specify the maximum number of matches required in each file.
  * Type is {@code int}.
  * Default value is {@code 0}.
  * </li>
  * <li>
- * Property {@code maximum} - Specify the maximum number of matches required in each file.
- * Type is {@code int}.
- * Default value is {@code 0}.
+ * Property {@code message} - Specify the message which is used to notify about
+ * violations, if empty then default (hard-coded) message is used.
+ * Type is {@code java.lang.String}.
+ * Default value is {@code null}.
  * </li>
  * <li>
- * Property {@code fileExtensions} - Specify the file type extension of files to process.
- * Type is {@code java.lang.String[]}.
- * Default value is {@code ""}.
+ * Property {@code minimum} - Specify the minimum number of matches required in each file.
+ * Type is {@code int}.
+ * Default value is {@code 0}.
  * </li>
  * </ul>
  * <p>

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpSinglelineJavaCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpSinglelineJavaCheck.java
@@ -44,30 +44,30 @@
  * Default value is {@code "$."}.
  * </li>
  * <li>
- * Property {@code message} - Specify the message which is used to notify about
- * violations, if empty then default (hard-coded) message is used.
- * Type is {@code java.lang.String}.
- * Default value is {@code null}.
- * </li>
- * <li>
  * Property {@code ignoreCase} - Control whether to ignore case when searching.
  * Type is {@code boolean}.
  * Default value is {@code false}.
  * </li>
  * <li>
- * Property {@code minimum} - Specify the minimum number of matches required in each file.
- * Type is {@code int}.
- * Default value is {@code 0}.
+ * Property {@code ignoreComments} - Control whether to ignore text in comments when searching.
+ * Type is {@code boolean}.
+ * Default value is {@code false}.
  * </li>
  * <li>
  * Property {@code maximum} - Specify the maximum number of matches required in each file.
  * Type is {@code int}.
  * Default value is {@code 0}.
  * </li>
  * <li>
- * Property {@code ignoreComments} - Control whether to ignore text in comments when searching.
- * Type is {@code boolean}.
- * Default value is {@code false}.
+ * Property {@code message} - Specify the message which is used to notify about
+ * violations, if empty then default (hard-coded) message is used.
+ * Type is {@code java.lang.String}.
+ * Default value is {@code null}.
+ * </li>
+ * <li>
+ * Property {@code minimum} - Specify the minimum number of matches required in each file.
+ * Type is {@code int}.
+ * Default value is {@code 0}.
  * </li>
  * </ul>
  * <p>

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/DescendantTokenCheck.xml b/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/DescendantTokenCheck.xml
@@ -22,29 +22,29 @@
                       validation-type="tokenTypesSet">
                <description>Specify set of tokens with limited occurrences as descendants.</description>
             </property>
-            <property default-value="0" name="minimumDepth" type="int">
-               <description>Specify the minimum depth for descendant counts.</description>
-            </property>
             <property default-value="2147483647" name="maximumDepth" type="int">
                <description>Specify the maximum depth for descendant counts.</description>
             </property>
-            <property default-value="0" name="minimumNumber" type="int">
-               <description>Specify a minimum count for descendants.</description>
+            <property name="maximumMessage" type="java.lang.String">
+               <description>Define the violation message
+ when the maximum count is exceeded.</description>
             </property>
             <property default-value="2147483647" name="maximumNumber" type="int">
                <description>Specify a maximum count for descendants.</description>
             </property>
-            <property default-value="false" name="sumTokenCounts" type="boolean">
-               <description>Control whether the number of tokens found
- should be calculated from the sum of the individual token counts.</description>
+            <property default-value="0" name="minimumDepth" type="int">
+               <description>Specify the minimum depth for descendant counts.</description>
             </property>
             <property name="minimumMessage" type="java.lang.String">
                <description>Define the violation message
  when the minimum count is not reached.</description>
             </property>
-            <property name="maximumMessage" type="java.lang.String">
-               <description>Define the violation message
- when the maximum count is exceeded.</description>
+            <property default-value="0" name="minimumNumber" type="int">
+               <description>Specify a minimum count for descendants.</description>
+            </property>
+            <property default-value="false" name="sumTokenCounts" type="boolean">
+               <description>Control whether the number of tokens found
+ should be calculated from the sum of the individual token counts.</description>
             </property>
             <property default-value="" name="tokens" type="anyTokenTypesSet">
                <description>tokens to check</description>

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/NewlineAtEndOfFileCheck.xml b/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/NewlineAtEndOfFileCheck.xml
@@ -48,14 +48,14 @@
  platforms, with the {@code lineSeparator} property.
  &lt;/p&gt;</description>
          <properties>
+            <property default-value="" name="fileExtensions" type="java.lang.String[]">
+               <description>Specify the file type extension of the files to check.</description>
+            </property>
             <property default-value="lf_cr_crlf"
                       name="lineSeparator"
                       type="com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption">
                <description>Specify the type of line separator.</description>
             </property>
-            <property default-value="" name="fileExtensions" type="java.lang.String[]">
-               <description>Specify the file type extension of the files to check.</description>
-            </property>
          </properties>
          <message-keys>
             <message-key key="noNewlineAtEOF"/>

diff --git a/.../resources/com/puppycrawl/tools/checkstyle/meta/checks/javadoc/SingleLineJavadocCheck.xml b/.../resources/com/puppycrawl/tools/checkstyle/meta/checks/javadoc/SingleLineJavadocCheck.xml
@@ -9,22 +9,22 @@
  Javadoc comment that contains at least one block tag should be formatted in a few lines.
  &lt;/p&gt;</description>
          <properties>
-            <property default-value="false"
-                      name="violateExecutionOnNonTightHtml"
-                      type="boolean">
-               <description>Control when to print violations
- if the Javadoc being examined by this check violates the tight html rules defined at
- &lt;a href="https://checkstyle.org/writingjavadocchecks.html#Tight-HTML_rules"&gt;Tight-HTML Rules&lt;/a&gt;.</description>
+            <property default-value="true" name="ignoreInlineTags" type="boolean">
+               <description>Control whether
+ &lt;a href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBEFIF"&gt;
+ inline tags&lt;/a&gt; must be ignored.</description>
             </property>
             <property default-value="" name="ignoredTags" type="java.lang.String[]">
                <description>Specify
  &lt;a href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBEFIF"&gt;
  block tags&lt;/a&gt; which are ignored by the check.</description>
             </property>
-            <property default-value="true" name="ignoreInlineTags" type="boolean">
-               <description>Control whether
- &lt;a href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBEFIF"&gt;
- inline tags&lt;/a&gt; must be ignored.</description>
+            <property default-value="false"
+                      name="violateExecutionOnNonTightHtml"
+                      type="boolean">
+               <description>Control when to print violations
+ if the Javadoc being examined by this check violates the tight html rules defined at
+ &lt;a href="https://checkstyle.org/writingjavadocchecks.html#Tight-HTML_rules"&gt;Tight-HTML Rules&lt;/a&gt;.</description>
             </property>
          </properties>
          <message-keys>

diff --git a/...in/resources/com/puppycrawl/tools/checkstyle/meta/checks/regexp/RegexpOnFilenameCheck.xml b/...in/resources/com/puppycrawl/tools/checkstyle/meta/checks/regexp/RegexpOnFilenameCheck.xml
@@ -45,26 +45,26 @@
  messages.
  &lt;/p&gt;</description>
          <properties>
-            <property name="folderPattern" type="java.util.regex.Pattern">
-               <description>Specify the regular expression to match the folder path against.</description>
+            <property default-value="" name="fileExtensions" type="java.lang.String[]">
+               <description>Specify the file type extension of files to process. If this is
+ specified, then only files that match these types are examined with the other
+ patterns.</description>
             </property>
             <property name="fileNamePattern" type="java.util.regex.Pattern">
                <description>Specify the regular expression to match the file name against.</description>
             </property>
-            <property default-value="true" name="match" type="boolean">
-               <description>Control whether to look for a match or mismatch on the file name, if
- the fileNamePattern is supplied, otherwise it is applied on the folderPattern.</description>
+            <property name="folderPattern" type="java.util.regex.Pattern">
+               <description>Specify the regular expression to match the folder path against.</description>
             </property>
             <property default-value="false"
                       name="ignoreFileNameExtensions"
                       type="boolean">
                <description>Control whether to ignore the file extension for
  the file name match.</description>
             </property>
-            <property default-value="" name="fileExtensions" type="java.lang.String[]">
-               <description>Specify the file type extension of files to process. If this is
- specified, then only files that match these types are examined with the other
- patterns.</description>
+            <property default-value="true" name="match" type="boolean">
+               <description>Control whether to look for a match or mismatch on the file name, if
+ the fileNamePattern is supplied, otherwise it is applied on the folderPattern.</description>
             </property>
          </properties>
          <message-keys>