Skip to content

Commit e89621e

Browse files
luvtypingromani
authored andcommitted
Issue #13213: Remove //ok comments from javadoctagcontinuationindentation
1 parent 5f5e87c commit e89621e

File tree

4 files changed

+9
-27
lines changed

4 files changed

+9
-27
lines changed

config/checkstyle-input-suppressions.xml

-18
Original file line numberDiff line numberDiff line change
@@ -433,24 +433,6 @@
433433
files="checks[\\/]javadoc[\\/]javadocmissingleadingasterisk[\\/]InputJavadocMissingLeadingAsteriskCorrect.java"/>
434434
<suppress id="UnnecessaryOkComment"
435435
files="checks[\\/]javadoc[\\/]javadocmissingleadingasterisk[\\/]InputJavadocMissingLeadingAsteriskCorrect.java"/>
436-
<suppress id="UnnecessaryOkComment"
437-
files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentation.java"/>
438-
<suppress id="UnnecessaryOkComment"
439-
files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentationBlockTag.java"/>
440-
<suppress id="UnnecessaryOkComment"
441-
files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentationBlockTag.java"/>
442-
<suppress id="UnnecessaryOkComment"
443-
files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentationBlockTag.java"/>
444-
<suppress id="UnnecessaryOkComment"
445-
files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentationBlockTag.java"/>
446-
<suppress id="UnnecessaryOkComment"
447-
files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentationBlockTag.java"/>
448-
<suppress id="UnnecessaryOkComment"
449-
files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentationBlockTag.java"/>
450-
<suppress id="UnnecessaryOkComment"
451-
files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentationBlockTag.java"/>
452-
<suppress id="UnnecessaryOkComment"
453-
files="checks[\\/]javadoc[\\/]javadoctagcontinuationindentation[\\/]InputJavadocTagContinuationIndentationGuavaFalsePositive.java"/>
454436
<suppress id="UnnecessaryOkComment"
455437
files="checks[\\/]javadoc[\\/]missingjavadocmethod[\\/]InputMissingJavadocMethodAllowedAnnotations.java"/>
456438
<suppress id="UnnecessaryOkComment"

src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadoctagcontinuationindentation/InputJavadocTagContinuationIndentation.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ interface FooIn1 {}
339339

340340
/**
341341
* <p>Testing javadoc with spanning tag {@linkplain #DEFAULT default mapping
342-
* factory}.</p> // ok
342+
* factory}.</p>
343343
*/
344344
interface FooIn2 {}
345345
class ShortNextLine {

src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadoctagcontinuationindentation/InputJavadocTagContinuationIndentationBlockTag.java

+7-7
Original file line numberDiff line numberDiff line change
@@ -50,17 +50,17 @@ public void partialIndent(int x) {
5050
*
5151
* @param x input
5252
* @return itself
53-
* */ // ok
53+
* */
5454
public int identity(int x) {
5555
return x;
5656
}
5757

5858
/**
5959
* Javadoc.
6060
*
61-
* @param args // ok
61+
* @param args
6262
* {@code this} line is not correctly indented // violation
63-
* {@code this} // ok
63+
* {@code this}
6464
* <pre>this line is not correctly indented</pre> // violation
6565
*/
6666
public void multipleLines1(String args) {
@@ -70,7 +70,7 @@ public void multipleLines1(String args) {
7070
/**
7171
* Javadoc.
7272
*
73-
* @return false always // ok
73+
* @return false always
7474
* {@code this} line is not correctly indented // violation
7575
* {@code this} line is not correctly indented // violation
7676
* <pre>this line is not correctly indented</pre> // violation
@@ -98,12 +98,12 @@ public boolean isMultipleLines2() {
9898
* <li>cvsroot</li> // violation
9999
* <li>noexec</li> // violation
100100
* <li>
101-
* another item // ok
101+
* another item
102102
* </li>
103-
* <li> yet another item </li> // ok
103+
* <li> yet another item </li>
104104
* </ul> // violation
105105
* some text <i>word</i> more text. // violation
106-
* some text <i>word</i> more text. // ok
106+
* some text <i>word</i> more text.
107107
*/
108108
public String regressionNestedHtml(CharSequence c) {
109109
return "";

src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadoctagcontinuationindentation/InputJavadocTagContinuationIndentationGuavaFalsePositive.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
class InputJavadocTagContinuationIndentationGuavaFalsePositive {
1414

1515
/**
16-
* This class implements the GWT serialization of {@link HashMultimap}. // ok
16+
* This class implements the GWT serialization of {@link HashMultimap}.
1717
*
1818
* @author Jord Sonneveld
1919
*

0 commit comments

Comments
 (0)