supplemental: refactor misaligned leading asterisks in javadoc comments

Zopsss · romani · commit f4b71587d76f · 2024-03-27T06:14:44.000-07:00
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/api/TokenTypes.java b/src/main/java/com/puppycrawl/tools/checkstyle/api/TokenTypes.java
@@ -37,7 +37,7 @@ public final class TokenTypes {
      * This is the root node for the source file.  It's children
      * are an optional package definition, zero or more import statements,
      * and zero or more type declarations.
-      * <p>For example:</p>
+     * <p>For example:</p>
      * <pre>
      * import java.util.List;
      *
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/DescendantTokenCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/DescendantTokenCheck.java
@@ -345,11 +345,11 @@ public void setMinimumNumber(int minimumNumber) {
     }
 
     /**
-      * Setter to specify a maximum count for descendants.
-      *
-      * @param maximumNumber the maximum count for descendants.
-      * @since 3.2
-      */
+     * Setter to specify a maximum count for descendants.
+     *
+     * @param maximumNumber the maximum count for descendants.
+     * @since 3.2
+     */
     public void setMaximumNumber(int maximumNumber) {
         this.maximumNumber = maximumNumber;
     }
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/LeftCurlyCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/LeftCurlyCheck.java
@@ -151,7 +151,7 @@ public class LeftCurlyCheck
 
     /**
      * Specify the policy on placement of a left curly brace (<code>'{'</code>).
-     * */
+     */
     private LeftCurlyOption option = LeftCurlyOption.EOL;
 
     /**
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheck.java
@@ -162,7 +162,7 @@ private static final class Details {
          * C-tor.
          *
          * @param ast class ast
-         * */
+         */
         private Details(DetailAST ast) {
             this.ast = ast;
         }
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/site/PropertiesMacro.java b/src/main/java/com/puppycrawl/tools/checkstyle/site/PropertiesMacro.java
@@ -105,7 +105,7 @@ public class PropertiesMacro extends AbstractMacro {
     /**
      * This property is used to change the existing properties for javadoc.
      * Tokens always present at the end of all properties.
-    */
+     */
     private static final String TOKENS_PROPERTY = SiteUtil.TOKENS;
 
     /** The name of the current module being processed. */
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/utils/XpathUtil.java b/src/main/java/com/puppycrawl/tools/checkstyle/utils/XpathUtil.java
@@ -101,7 +101,7 @@ public final class XpathUtil {
      * </pre>
      * Only these tokens support text attribute because they make our xpath queries more accurate.
      * These token types are listed below.
-     * */
+     */
     private static final BitSet TOKEN_TYPES_WITH_TEXT_ATTRIBUTE = TokenUtil.asBitSet(
             TokenTypes.IDENT, TokenTypes.STRING_LITERAL, TokenTypes.CHAR_LITERAL,
             TokenTypes.NUM_LONG, TokenTypes.NUM_INT, TokenTypes.NUM_DOUBLE, TokenTypes.NUM_FLOAT,
diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/PackageObjectFactoryTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/PackageObjectFactoryTest.java
@@ -494,11 +494,11 @@ public void testCreateObjectWithNameContainingPackageSeparator() throws Exceptio
     }
 
     /**
-    * This test case is designed to verify the behavior of the PackageObjectFactory's
-    * createModule method when it is provided with a fully qualified class name
-    * (containing a package separator).
-    * It ensures that ModuleReflectionUtil.getCheckstyleModules is not executed in this case.
-    */
+     * This test case is designed to verify the behavior of the PackageObjectFactory's
+     * createModule method when it is provided with a fully qualified class name
+     * (containing a package separator).
+     * It ensures that ModuleReflectionUtil.getCheckstyleModules is not executed in this case.
+     */
     @Test
     public void testCreateObjectWithNameContainingPackageSeparatorWithoutSearch() throws Exception {
         final ClassLoader classLoader = ClassLoader.getSystemClassLoader();
diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/utils/ModuleReflectionUtilTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/utils/ModuleReflectionUtilTest.java
@@ -80,10 +80,10 @@ public void testIsCheckstyleModule() {
     }
 
     /**
-    * This test case is designed to verify the behavior of getCheckstyleModules method.
-    * It is provided with a package name that does not contain any checkstyle modules.
-    * It ensures that ModuleReflectionUtil.getCheckstyleModules is returning an empty set.
-    */
+     * This test case is designed to verify the behavior of getCheckstyleModules method.
+     * It is provided with a package name that does not contain any checkstyle modules.
+     * It ensures that ModuleReflectionUtil.getCheckstyleModules is returning an empty set.
+     */
     @Test
     public void testGetCheckStyleModules() throws IOException {
         final ClassLoader classLoader = ClassLoader.getSystemClassLoader();

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public final class TokenTypes {`
`37`	`37`	`* This is the root node for the source file. It's children`
`38`	`38`	`* are an optional package definition, zero or more import statements,`
`39`	`39`	`* and zero or more type declarations.`
`40`		`- * <p>For example:</p>`
	`40`	`+ * <p>For example:</p>`
`41`	`41`	`* <pre>`
`42`	`42`	`* import java.util.List;`
`43`	`43`	`*`
Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,7 @@ private static final class Details {`
`162`	`162`	`* C-tor.`
`163`	`163`	`*`
`164`	`164`	`* @param ast class ast`
`165`		`- * */`
	`165`	`+ */`
`166`	`166`	`private Details(DetailAST ast) {`
`167`	`167`	`this.ast = ast;`
`168`	`168`	`}`