Skip to content

Commit

Permalink
Issue #13213: Remove '//ok' comments from InputJavadocMethodExtraThrows
Browse files Browse the repository at this point in the history
  • Loading branch information
@prathm3 @romani
prathm3 authored and romani committed Apr 26, 2024
1 parent 40a1bba commit 508c361
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 66 deletions.
44 changes: 0 additions & 44 deletions config/checkstyle-input-suppressions.xml
View file
Expand Up @@ -221,50 +221,6 @@
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtendAnnotation.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtendAnnotation.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodExtraThrows.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodGenerics.java"/>
<suppress id="UnnecessaryOkComment"
Expand Down
44 changes: 22 additions & 22 deletions ...ppycrawl/tools/checkstyle/checks/javadoc/javadocmethod/InputJavadocMethodExtraThrows.java
View file
Expand Up @@ -21,10 +21,10 @@ public class InputJavadocMethodExtraThrows {
/**
* Extra throws in javadoc it is ok.
* @param properties some value
* @throws IllegalArgumentException when argument is wrong // ok
* @throws NullPointerException indicates null was passed // ok
* @throws IllegalArgumentException when argument is wrong
* @throws NullPointerException indicates null was passed
*/
public InputJavadocMethodExtraThrows(String properties) { // ok
public InputJavadocMethodExtraThrows(String properties) {
// here is NPE possible
if (properties.charAt(0) == 0) {
throw new IllegalArgumentException("cannot have char with code 0");
Expand All @@ -34,10 +34,10 @@ public InputJavadocMethodExtraThrows(String properties) { // ok
/**
* Extra throws in javadoc it is ok
* @param properties some value
* @throws java.lang.IllegalArgumentException when argument is wrong // ok
* @throws java.lang.NullPointerException indicates null was passed // ok
* @throws java.lang.IllegalArgumentException when argument is wrong
* @throws java.lang.NullPointerException indicates null was passed
*/
public void doSomething(String properties) throws IllegalArgumentException { // ok
public void doSomething(String properties) throws IllegalArgumentException {
// here is NPE possible
if (properties.charAt(0) == 0) {
throw new IllegalArgumentException("cannot have char with code 0");
Expand All @@ -47,8 +47,8 @@ public void doSomething(String properties) throws IllegalArgumentException { //
/**
* declared exception in method signature is missed in javadoc
* @param properties some value
* @throws java.lang.IllegalArgumentException when argument is wrong // ok
* @throws java.lang.NullPointerException indicates null was passed // ok
* @throws java.lang.IllegalArgumentException when argument is wrong
* @throws java.lang.NullPointerException indicates null was passed
*/
// violation below 'Expected @throws tag for 'IllegalStateException'.'
public void doSomething2(String properties) throws IllegalStateException {
Expand All @@ -61,9 +61,9 @@ public void doSomething2(String properties) throws IllegalStateException {
/**
* exception is explitly thrown in code missed in javadoc
* @param properties some value
* @throws java.lang.IllegalStateException when argument is wrong // ok
* @throws java.lang.IllegalStateException when argument is wrong
*/
public void doSomething3(String properties) throws IllegalStateException { // ok
public void doSomething3(String properties) throws IllegalStateException {
// here is NPE possible
if (properties.charAt(0) == 0) {
// violation below 'Expected @throws tag for 'IllegalArgumentException'.'
Expand All @@ -74,9 +74,9 @@ public void doSomething3(String properties) throws IllegalStateException { // ok
/**
* exception is explitly thrown in code missed in javadoc
* @param properties some value
* @throws java.lang.IllegalStateException when argument is wrong // ok
* @throws java.lang.IllegalStateException when argument is wrong
*/
public void doSomething4(String properties) { // ok
public void doSomething4(String properties) {
// here is NPE possible
if (properties.charAt(0) == 0) {
// violation below 'Expected @throws tag for 'IllegalArgumentException'.'
Expand All @@ -87,7 +87,7 @@ public void doSomething4(String properties) { // ok
/**
* exception is explitly thrown in code missed in javadoc
* @param properties some value
* @throws java.lang.IllegalStateException when argument is wrong // ok
* @throws java.lang.IllegalStateException when argument is wrong
*/
public void doSomething5(String properties) {
// here is NPE possible
Expand All @@ -99,26 +99,26 @@ public void doSomething5(String properties) {
}

/**
* expicitly throwed is declared in javadoc // ok
* expicitly throwed is declared in javadoc
* @param properties some value
* @throws IllegalArgumentException when argument is wrong // ok
* @throws IllegalArgumentException when argument is wrong
*/
public void doSomething6(String properties) { // ok
public void doSomething6(String properties) {
// here is NPE possible
if (properties.charAt(0) == 0) {
throw new java.lang.IllegalArgumentException("cannot have char with code 0");
}
}

/**
* expicitly throwed but throwed as variable, we do not catch this for now // ok
* expicitly throwed but throwed as variable, we do not catch this for now
* @param properties some value
*/
public void doSomething7(String properties) { // ok
public void doSomething7(String properties) {
// here is NPE possible
if (properties.charAt(0) == 0) {
IllegalArgumentException exception =
new IllegalArgumentException("cannot have char with code 0"); // ok
new IllegalArgumentException("cannot have char with code 0");
throw exception;
}
}
Expand All @@ -131,7 +131,7 @@ public void doSomething7(String properties) { // ok
* @param file some file
* @throws IOException if some problem
*/
public void doSomething8(File file) throws IOException { // ok
public void doSomething8(File file) throws IOException {
if (file == null) {
// violation below 'Expected @throws tag for 'FileNotFoundException'.'
throw new FileNotFoundException();
Expand All @@ -146,9 +146,9 @@ public void doSomething8(File file) throws IOException { // ok
* @throws IOException if some problem
* @throws FileNotFoundException if file is not found
*/
public void doSomething9(File file) throws IOException { // ok
public void doSomething9(File file) throws IOException {
if (file == null) {
throw new FileNotFoundException(); // ok
throw new FileNotFoundException();
}
}
}

0 comments on commit 508c361

Please sign in to comment.