Skip to content

Add JavadocPackageCheck to the default Spring checks #328

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.

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

Closed
wilkinsona opened this issue May 23, 2022 · 3 comments
Closed

Add JavadocPackageCheck to the default Spring checks #328

wilkinsona opened this issue May 23, 2022 · 3 comments

Comments

@wilkinsona
Copy link
Contributor

No description provided.

@spencergibb
Copy link

Can it be optional?

@philwebb
Copy link
Contributor

It should be easy enough to exclude

@wilkinsona
Copy link
Contributor Author

The check can be excluded completely using the excludes property when declaring the SpringChecks module:

<module name="io.spring.javaformat.checkstyle.SpringChecks">
    <property name="excludes" value="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck" />
</module>

Alternatively, JavadocPackage can be suppressed in checkstyle-suppressions.xml for specific files where the check is unwanted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants