Merge 877eda8 into 6269e84

checkstyle · Apr 23, 2024 · b103215 · b103215
2 parents 6269e84 + 877eda8
commit b103215
Show file tree

Hide file tree

Showing 36 changed files with 1,227 additions and 4 deletions.
diff --git a/config/checker-framework-suppressions/checker-index-suppressions.xml b/config/checker-framework-suppressions/checker-index-suppressions.xml
@@ -1376,6 +1376,28 @@
     </details>
   </checkerFrameworkError>
 
+  <checkerFrameworkError unstable="false">
+    <fileName>src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocLeadingAsteriskAlignCheck.java</fileName>
+    <specifier>array.access.unsafe.high</specifier>
+    <message>Potentially unsafe array access: the index could be larger than the array&apos;s bound</message>
+    <lineContent>final String startLine = getLines()[rootAst.getLineNumber() - 1];</lineContent>
+    <details>
+      found   : int
+      required: @IndexFor(&quot;this.getLines()&quot;) or @LTLengthOf(&quot;this.getLines()&quot;) -- an integer less than this.getLines()&apos;s length
+    </details>
+  </checkerFrameworkError>
+
+  <checkerFrameworkError unstable="false">
+    <fileName>src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocLeadingAsteriskAlignCheck.java</fileName>
+    <specifier>array.access.unsafe.low</specifier>
+    <message>Potentially unsafe array access: the index could be negative.</message>
+    <lineContent>final String startLine = getLines()[rootAst.getLineNumber() - 1];</lineContent>
+    <details>
+      found   : int
+      required: an integer &gt;= 0 (@NonNegative or @Positive)
+    </details>
+  </checkerFrameworkError>
+
   <checkerFrameworkError unstable="false">
     <fileName>src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java</fileName>
     <specifier>array.access.unsafe.high</specifier>

diff --git a/config/checker-framework-suppressions/checker-nullness-optional-interning-suppressions.xml b/config/checker-framework-suppressions/checker-nullness-optional-interning-suppressions.xml
@@ -3901,6 +3901,27 @@
     </details>
   </checkerFrameworkError>
 
+  <checkerFrameworkError unstable="false">
+    <fileName>src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocLeadingAsteriskAlignCheck.java</fileName>
+    <specifier>dereference.of.nullable</specifier>
+    <message>dereference of possibly-null reference matcher.group(1)</message>
+    <lineContent>columnNumber = matcher.group(1).length() + 1;</lineContent>
+  </checkerFrameworkError>
+
+  <checkerFrameworkError unstable="false">
+    <fileName>src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocLeadingAsteriskAlignCheck.java</fileName>
+    <specifier>dereference.of.nullable</specifier>
+    <message>dereference of possibly-null reference matcher.group(1)</message>
+    <lineContent>return matcher.group(1).length() + 2;</lineContent>
+  </checkerFrameworkError>
+
+  <checkerFrameworkError unstable="false">
+    <fileName>src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocLeadingAsteriskAlignCheck.java</fileName>
+    <specifier>dereference.of.nullable</specifier>
+    <message>dereference of possibly-null reference matcher2.group(1)</message>
+    <lineContent>singleSpaceAsteriskColNumber = matcher2.group(1).length() + 1;</lineContent>
+  </checkerFrameworkError>
+
   <checkerFrameworkError unstable="false">
     <fileName>src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java</fileName>
     <specifier>argument</specifier>

diff --git a/config/checkstyle-checks.xml b/config/checkstyle-checks.xml
@@ -675,6 +675,7 @@
       <property name="validateThrows" value="true"/>
     </module>
     <module name="JavadocMissingLeadingAsterisk"/>
+    <module name="JavadocLeadingAsteriskAlign"/>
     <module name="JavadocMissingWhitespaceAfterAsterisk"/>
     <module name="JavadocParagraph"/>
     <module name="JavadocStyle">

diff --git a/config/checkstyle-resources-suppressions.xml b/config/checkstyle-resources-suppressions.xml
@@ -156,6 +156,8 @@
     files="[\\/]InputMagicNumberAnnotationElement\.java"/>
   <suppress checks="FileTabCharacter"
     files="[\\/]InputInnerTypeLastClass\.java"/>
+  <suppress checks="FileTabCharacter"
+    files="[\\/]InputJavadocLeadingAsteriskAlignTabs\.java"/>
   <suppress checks="FileTabCharacter"
     files="[\\/]InputJavadocMissingWhitespaceAfterAsteriskValidWithTab\.java"/>
   <suppress checks="FileTabCharacter"

diff --git a/config/jsoref-spellchecker/whitelist.words b/config/jsoref-spellchecker/whitelist.words
@@ -633,6 +633,7 @@ javadoc
 javadocblocktaglocation
 javadoccontentlocation
 javadocdetailnodeparser
+javadocleadingasteriskalign
 javadocmetadatascraper
 javadocmethod
 javadocmissingleadingasterisk

diff --git a/config/linkcheck-suppressions.txt b/config/linkcheck-suppressions.txt
@@ -519,6 +519,7 @@
 <a href="apidocs/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocBlockTagLocationCheck.html#%3Cinit%3E()">#%3Cinit%3E()</a>: doesn't exist.
 <a href="apidocs/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocContentLocationCheck.html#%3Cinit%3E()">#%3Cinit%3E()</a>: doesn't exist.
 <a href="apidocs/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocContentLocationOption.html#%3Cinit%3E()">#%3Cinit%3E()</a>: doesn't exist.
+<a href="apidocs/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocLeadingAsteriskAlignCheck.html#%3Cinit%3E()">#%3Cinit%3E()</a>: doesn't exist.
 <a href="apidocs/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.ClassInfo.html#%3Cinit%3E(com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.Token)">#%3Cinit%3E(com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.Token)</a>: doesn't exist.
 <a href="apidocs/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.ClassInfo.html#%3Cinit%3E(com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.Token)">../JavadocMethodCheck.ClassInfo.html#%3Cinit%3E(com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.Token)</a>: doesn't exist.
 <a href="apidocs/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.ExceptionInfo.html#%3Cinit%3E(com.puppycrawl.tools.checkstyle.api.DetailAST,com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.ClassInfo)">#%3Cinit%3E(com.puppycrawl.tools.checkstyle.api.DetailAST,com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.ClassInfo)</a>: doesn't exist.
@@ -1107,6 +1108,7 @@
 <a href="com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocBlockTagLocationCheck.html#%3Cinit%3E()">com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocBlockTagLocationCheck.html#%3Cinit%3E()</a>: doesn't exist.
 <a href="com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocContentLocationCheck.html#%3Cinit%3E()">com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocContentLocationCheck.html#%3Cinit%3E()</a>: doesn't exist.
 <a href="com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocContentLocationOption.html#%3Cinit%3E()">com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocContentLocationOption.html#%3Cinit%3E()</a>: doesn't exist.
+<a href="com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocLeadingAsteriskAlignCheck.html#%3Cinit%3E()">com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocLeadingAsteriskAlignCheck.html#%3Cinit%3E()</a>: doesn't exist.
 <a href="com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.ClassInfo.html#%3Cinit%3E(com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.Token)">com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.ClassInfo.html#%3Cinit%3E(com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.Token)</a>: doesn't exist.
 <a href="com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.ExceptionInfo.html#%3Cinit%3E(com.puppycrawl.tools.checkstyle.api.DetailAST,com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.ClassInfo)">com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.ExceptionInfo.html#%3Cinit%3E(com.puppycrawl.tools.checkstyle.api.DetailAST,com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.ClassInfo)</a>: doesn't exist.
 <a href="com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.Token.html#%3Cinit%3E(com.puppycrawl.tools.checkstyle.api.FullIdent)">com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.Token.html#%3Cinit%3E(com.puppycrawl.tools.checkstyle.api.FullIdent)</a>: doesn't exist.
@@ -1333,6 +1335,7 @@
 <a href="com/puppycrawl/tools/checkstyle/xpath/XpathQueryGenerator.html#%3Cinit%3E(com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent,int)">com/puppycrawl/tools/checkstyle/xpath/XpathQueryGenerator.html#%3Cinit%3E(com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent,int)</a>: doesn't exist.
 <a href="com/puppycrawl/tools/checkstyle/xpath/XpathQueryGenerator.html#%3Cinit%3E(com.puppycrawl.tools.checkstyle.api.DetailAST,int,int,com.puppycrawl.tools.checkstyle.api.FileText,int)">com/puppycrawl/tools/checkstyle/xpath/XpathQueryGenerator.html#%3Cinit%3E(com.puppycrawl.tools.checkstyle.api.DetailAST,int,int,com.puppycrawl.tools.checkstyle.api.FileText,int)</a>: doesn't exist.
 <a href="com/puppycrawl/tools/checkstyle/xpath/XpathQueryGenerator.html#%3Cinit%3E(com.puppycrawl.tools.checkstyle.api.DetailAST,int,int,int,com.puppycrawl.tools.checkstyle.api.FileText,int)">com/puppycrawl/tools/checkstyle/xpath/XpathQueryGenerator.html#%3Cinit%3E(com.puppycrawl.tools.checkstyle.api.DetailAST,int,int,int,com.puppycrawl.tools.checkstyle.api.FileText,int)</a>: doesn't exist.
+<a href="config_blocks.html#LeftCurly">config_blocks.html#LeftCurly</a>: doesn't exist.
 <a href="com/puppycrawl/tools/checkstyle/xpath/iterators/DescendantIterator.StartWith.html#%3Cinit%3E()">com/puppycrawl/tools/checkstyle/xpath/iterators/DescendantIterator.StartWith.html#%3Cinit%3E()</a>: doesn't exist.
 <a href="com/puppycrawl/tools/checkstyle/xpath/iterators/DescendantIterator.html#%3Cinit%3E(net.sf.saxon.om.NodeInfo,com.puppycrawl.tools.checkstyle.xpath.iterators.DescendantIterator.StartWith)">com/puppycrawl/tools/checkstyle/xpath/iterators/DescendantIterator.html#%3Cinit%3E(net.sf.saxon.om.NodeInfo,com.puppycrawl.tools.checkstyle.xpath.iterators.DescendantIterator.StartWith)</a>: doesn't exist.
 <a href="com/puppycrawl/tools/checkstyle/xpath/iterators/FollowingIterator.html#%3Cinit%3E(net.sf.saxon.om.NodeInfo)">com/puppycrawl/tools/checkstyle/xpath/iterators/FollowingIterator.html#%3Cinit%3E(net.sf.saxon.om.NodeInfo)</a>: doesn't exist.

diff --git a/config/spotbugs-exclude.xml b/config/spotbugs-exclude.xml
@@ -104,6 +104,8 @@
       <Class name="com.puppycrawl.tools.checkstyle.checks.coding.MatchXpathCheck"/>
       <Class name="com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck" />
       <Class name="com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck" />
+      <Class name=
+             "com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocLeadingAsteriskAlignCheck" />
       <!-- createJavadocNode is private and can not be launched without visitToken -->
       <Class name="com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck" />
       <!-- has only one public method and all initialized in that method -->

diff --git a/pom.xml b/pom.xml
@@ -1796,6 +1796,7 @@
                 <exclude>**/JavadocMethodCheck.class</exclude>
                 <exclude>**/JavadocMissingLeadingAsteriskCheck.class</exclude>
                 <exclude>**/JavadocMissingWhitespaceAfterAsteriskCheck.class</exclude>
+                <exclude>**/JavadocLeadingAsteriskAlignCheck.class</exclude>
                 <exclude>**/JavadocParagraphCheck.class</exclude>
                 <exclude>**/JavadocStyleCheck.class</exclude>
                 <exclude>**/JavadocTagContinuationIndentationCheck.class</exclude>

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/PackageObjectFactory.java b/src/main/java/com/puppycrawl/tools/checkstyle/PackageObjectFactory.java
@@ -679,6 +679,8 @@ private static void fillChecksFromJavadocPackage() {
                 BASE_PACKAGE + ".checks.javadoc.JavadocMethodCheck");
         NAME_TO_FULL_MODULE_NAME.put("JavadocMissingLeadingAsteriskCheck",
                 BASE_PACKAGE + ".checks.javadoc.JavadocMissingLeadingAsteriskCheck");
+        NAME_TO_FULL_MODULE_NAME.put("JavadocLeadingAsteriskAlignCheck",
+                BASE_PACKAGE + ".checks.javadoc.JavadocLeadingAsteriskAlignCheck");
         NAME_TO_FULL_MODULE_NAME.put("JavadocMissingWhitespaceAfterAsteriskCheck",
                 BASE_PACKAGE + ".checks.javadoc.JavadocMissingWhitespaceAfterAsteriskCheck");
         NAME_TO_FULL_MODULE_NAME.put("JavadocPackageCheck",