Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Issue #13213: Remove '//ok' comments from InputJavadocMethodProtected… #14834

Merged
merged 1 commit into from Apr 30, 2024
Merged

Issue #13213: Remove '//ok' comments from InputJavadocMethodProtected… #14834

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
26 changes: 0 additions & 26 deletions config/checkstyle-input-suppressions.xml
View file
Open in desktop
Expand Up @@ -297,32 +297,6 @@
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodParamsTags.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodParamsTags.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodProtectedScopeJavadoc.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodProtectedScopeJavadoc.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodProtectedScopeJavadoc.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodProtectedScopeJavadoc.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodProtectedScopeJavadoc.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodProtectedScopeJavadoc.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodProtectedScopeJavadoc.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodProtectedScopeJavadoc.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodProtectedScopeJavadoc.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodProtectedScopeJavadoc.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodProtectedScopeJavadoc.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodProtectedScopeJavadoc.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodProtectedScopeJavadoc.java"/>
<suppress id="UnnecessaryOkComment"
files="checks[\\/]javadoc[\\/]javadocmethod[\\/]InputJavadocMethodPublicOnly.java"/>
<suppress id="UnnecessaryOkComment"
Expand Down
26 changes: 13 additions & 13 deletions ...ools/checkstyle/checks/javadoc/javadocmethod/InputJavadocMethodProtectedScopeJavadoc.java
View file
Open in desktop
Expand Up @@ -12,9 +12,9 @@

package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocmethod;

public class InputJavadocMethodProtectedScopeJavadoc // ignore - need javadoc // ok
public class InputJavadocMethodProtectedScopeJavadoc // ignore - need javadoc
{
private interface InnerInterface // ignore - when not relaxed about Javadoc // ok
private interface InnerInterface // ignore - when not relaxed about Javadoc
{
String CONST = "InnerInterface"; // ignore - w.n.r.a.j
void method(); // ignore - when not relaxed about Javadoc
Expand All @@ -33,7 +33,7 @@ private InnerInnerClass()
void method2() // ignore - when not relaxed about Javadoc
{
final Runnable r = new Runnable() {
public void run() {}; // ok
public void run() {};
};
}
}
Expand All @@ -54,32 +54,32 @@ void method() // ignore - when not relaxed about Javadoc
public int aFreddo; // ignore

// ignore - need Javadoc
private InputJavadocMethodProtectedScopeJavadoc(int aA) // ok
private InputJavadocMethodProtectedScopeJavadoc(int aA)
{
}

// ignore - need Javadoc when not relaxed
InputJavadocMethodProtectedScopeJavadoc(String aA) // ok
InputJavadocMethodProtectedScopeJavadoc(String aA)
{
}

// ignore - always need javadoc
protected InputJavadocMethodProtectedScopeJavadoc(Object aA) // ok
protected InputJavadocMethodProtectedScopeJavadoc(Object aA)
{
}

// ignore - always need javadoc
public InputJavadocMethodProtectedScopeJavadoc(Class<Object> aA) // ok
public InputJavadocMethodProtectedScopeJavadoc(Class<Object> aA)
{
}

/** Here should not be an error, Out of scope */
private void method(int aA) // ok
private void method(int aA)
{
}

/** Here should not be an error, Out of scope */
void method(Long aA) // ok
void method(Long aA)
{
}

Expand All @@ -99,26 +99,26 @@ public void method(StringBuffer aA) // violation 'Expected @param tag for 'aA'.'
Writing a little documentation should not be worse than not
writing any documentation at all.
*/
private void method(String aA) // ok
private void method(String aA)
{
}

/**
This inner class has no author tag, which is OK.
*/
public class InnerWithoutAuthor // ok
public class InnerWithoutAuthor
{

}

/** {@inheritDoc} */
public String toString() // ok
public String toString()
{
return super.toString();
}

@Deprecated @Override
public int hashCode() // ok
public int hashCode()
{
return super.hashCode();
}
Expand Down