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

Enable Checkstyle's JavadocStyle module #451

Merged
merged 3 commits into from
Jan 23, 2023
Merged

Enable Checkstyle's JavadocStyle module #451

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
04be666
Enable Checkstyles `JavadocStyleCheck`
rickie Jan 6, 2023
37f5b3c
Enable `checkEmptyJavadoc`
rickie Jan 23, 2023
48d0ae7
Apply suggestion
rickie Jan 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ...one-contrib/src/test/java/tech/picnic/errorprone/bugpatterns/PrimitiveComparisonTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
// XXX: Can we perhaps work-around this by describing the fixes in reverse order?
final class PrimitiveComparisonTest {
/**
* Identification test for primitive {@code byte} comparisons.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Proposal to stick with the usual grammatical form:

Suggested change
* Identification test for primitive {@code byte} comparisons.
* Tests the identification of {@code byte} comparisons for which boxing can be avoided.

*
* @implNote The logic for {@code char} and {@code short} is exactly analogous to the {@code byte}
* case.
*/
Expand Down
3 changes: 3 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -710,6 +710,9 @@
<module name="InnerAssignment" />
<module name="InvalidJavadocPosition" />
<module name="JavadocBlockTagLocation" />
<module name="JavadocStyle">
<property name="checkEmptyJavadoc" value="true"/>
</module>
<module name="LocalVariableName" />
<module name="MatchXpath">
<property name="query" value="//BLOCK_COMMENT_BEGIN[./COMMENT_CONTENT[contains(@text, '@author')]]" />
Expand Down