Issue #13213: Remove //ok comments from javadoctagcontinuationindenta…

…tion
checkstyle · Nov 30, 2024 · e89621e · e89621e
1 parent 5f5e87c
commit e89621e
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 27 deletions.
diff --git a/config/checkstyle-input-suppressions.xml b/config/checkstyle-input-suppressions.xml
@@ -433,24 +433,6 @@
             files="checks[\\/]javadoc[\\/]javadocmissingleadingasterisk[\\/]InputJavadocMissingLeadingAsteriskCorrect.java"/>
   <suppress id="UnnecessaryOkComment"
             files="checks[\\/]javadoc[\\/]javadocmissingleadingasterisk[\\/]InputJavadocMissingLeadingAsteriskCorrect.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentation.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentationBlockTag.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentationBlockTag.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentationBlockTag.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentationBlockTag.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentationBlockTag.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentationBlockTag.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentationBlockTag.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentationGuavaFalsePositive.java"/>
   <suppress id="UnnecessaryOkComment"
             files="checks[\\/]javadoc[\\/]missingjavadocmethod[\\/]InputMissingJavadocMethodAllowedAnnotations.java"/>
   <suppress id="UnnecessaryOkComment"

diff --git a/...cks/javadoc/javadoctagcontinuationindentation/InputJavadocTagContinuationIndentation.java b/...cks/javadoc/javadoctagcontinuationindentation/InputJavadocTagContinuationIndentation.java
@@ -339,7 +339,7 @@ interface FooIn1 {}
 
 /**
  * <p>Testing javadoc with spanning tag {@linkplain #DEFAULT default mapping
- * factory}.</p> // ok
+ * factory}.</p>
  */
 interface FooIn2 {}
 class ShortNextLine {

diff --git a/...doc/javadoctagcontinuationindentation/InputJavadocTagContinuationIndentationBlockTag.java b/...doc/javadoctagcontinuationindentation/InputJavadocTagContinuationIndentationBlockTag.java
@@ -50,17 +50,17 @@ public void partialIndent(int x) {
      *
      * @param x input
      * @return itself
-     * */ // ok
+     * */
     public int identity(int x) {
         return x;
     }
 
     /**
      * Javadoc.
      *
-     * @param args // ok
+     * @param args
      * {@code this} line is not correctly indented // violation
-     *     {@code this} // ok
+     *     {@code this}
      * <pre>this line is not correctly indented</pre> // violation
      */
     public void multipleLines1(String args) {
@@ -70,7 +70,7 @@ public void multipleLines1(String args) {
     /**
      * Javadoc.
      *
-     * @return false always // ok
+     * @return false always
      * {@code this} line is not correctly indented // violation
      * {@code this} line is not correctly indented // violation
      * <pre>this line is not correctly indented</pre> // violation
@@ -98,12 +98,12 @@ public boolean isMultipleLines2() {
      * <li>cvsroot</li> // violation
      * <li>noexec</li> // violation
      *     <li>
-     *     another item // ok
+     *     another item
      *     </li>
-     *     <li> yet another item </li> // ok
+     *     <li> yet another item </li>
      * </ul> // violation
      * some text <i>word</i> more text. // violation
-     *     some text <i>word</i> more text. // ok
+     *     some text <i>word</i> more text.
      */
     public String regressionNestedHtml(CharSequence c) {
         return "";

diff --git a/...ctagcontinuationindentation/InputJavadocTagContinuationIndentationGuavaFalsePositive.java b/...ctagcontinuationindentation/InputJavadocTagContinuationIndentationGuavaFalsePositive.java
@@ -13,7 +13,7 @@
 class InputJavadocTagContinuationIndentationGuavaFalsePositive {
 
     /**
-     * This class implements the GWT serialization of {@link HashMultimap}. // ok
+     * This class implements the GWT serialization of {@link HashMultimap}.
      *
      * @author Jord Sonneveld
      *