Skip to content

Issue #19803: move violation comments outside method signature #19804

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

Merged
romani merged 1 commit into from
May 13, 2026
Merged

Issue #19803: move violation comments outside method signature #19804

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions config/checkstyle-input-suppressions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,8 +307,6 @@
files="[\\/]checks[\\/]javadoc[\\/]missingjavadocpackage[\\/]nojavadoc[\\/]annotation[\\/]blockcomment[\\/]package-info\.java"/>
<suppress id="violationBetweenAnnotationAndMethod"
files="[\\/]checks[\\/]javadoc[\\/]missingjavadocpackage[\\/]nojavadoc[\\/]annotation[\\/]package-info\.java"/>
<suppress id="violationBetweenJavadocAndMethod"
files="[\\/]checks[\\/]javadoc[\\/]summaryjavadoc[\\/]InputSummaryJavadocIncorrect3\.java"/>
<suppress id="violationBetweenAnnotationAndMethod"
files="[\\/]checks[\\/]javadoc[\\/]writetag[\\/]InputWriteTagEnumsAndAnnotations\.java"/>
<suppress id="violationBetweenJavadocAndMethod"
Expand Down
10 changes: 5 additions & 5 deletions src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheckTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,16 +195,16 @@ public void testDefaultConfiguration2() throws Exception {
@Test
public void testIncorrectUsageOfSummaryTag() throws Exception {
final String[] expected = {
"34:8: " + getCheckMessage(MSG_SUMMARY_MISSING_PERIOD),
"35:8: " + getCheckMessage(MSG_SUMMARY_MISSING_PERIOD),
"41:8: " + getCheckMessage(MSG_SUMMARY_JAVADOC_MISSING),
"49:8: " + getCheckMessage(MSG_SUMMARY_FIRST_SENTENCE),
"57:8: " + getCheckMessage(MSG_SUMMARY_MISSING_PERIOD),
"58:8: " + getCheckMessage(MSG_SUMMARY_MISSING_PERIOD),
"64:8: " + getCheckMessage(MSG_SUMMARY_FIRST_SENTENCE),
"74:8: " + getCheckMessage(MSG_SUMMARY_MISSING_PERIOD),
"75:8: " + getCheckMessage(MSG_SUMMARY_MISSING_PERIOD),
// Until https://github.com/checkstyle/checkstyle/issues/11425
"82:8: " + getCheckMessage(MSG_SUMMARY_JAVADOC_MISSING),
"93:8: " + getCheckMessage(MSG_SUMMARY_MISSING_PERIOD),
"103:8: " + getCheckMessage(MSG_SUMMARY_MISSING_PERIOD),
"94:8: " + getCheckMessage(MSG_SUMMARY_MISSING_PERIOD),
"104:8: " + getCheckMessage(MSG_SUMMARY_MISSING_PERIOD),
"110:8: " + getCheckMessage(MSG_SUMMARY_JAVADOC_MISSING),
};

Expand Down
10 changes: 5 additions & 5 deletions ...pycrawl/tools/checkstyle/checks/javadoc/summaryjavadoc/InputSummaryJavadocIncorrect3.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ public void testAnotherSummaryTag() {
public void testHtmlTags() {
}

// violation 3 lines below 'Summary of Javadoc is missing an ending period'
/**
* <p><i></i></p>
* {@summary This is summary}
*/
// violation 2 lines above 'Summary of Javadoc is missing an ending period'
public void testHtmlTags2() {
}

Expand All @@ -52,11 +52,11 @@ public void method(int a) {
public void testParagraphTag() {
}

// violation 3 lines below 'Summary of Javadoc is missing an ending period'
/**
* <pre></pre>
* {@summary This is summary}
*/
// violation 2 lines above 'Summary of Javadoc is missing an ending period'
public void testPreTag() {
}

Expand All @@ -68,12 +68,12 @@ public void testPreTag() {
public void testOtherTags() {
}

// violation 4 lines below 'Summary of Javadoc is missing an ending period.'
/**
* <br>
* <br>
* {@summary Line breaks will be there but this will be the summary}
*/
// violation 2 lines above 'Summary of Javadoc is missing an ending period.'
public void testBreakTag() {
}

Expand All @@ -88,21 +88,21 @@ public void testBreakTag() {
public void testMultipleElements() {
}

// violation 3 lines below 'Summary of Javadoc is missing an ending period'
/**
* <p> </p>
* {@summary This is not the summary}
*/
// violation 2 lines above 'Summary of Javadoc is missing an ending period'
public void testHtmlTags3() {
}

// violation 5 lines below 'Summary of Javadoc is missing an ending period'
/**
* <p>
*
* </p>
* {@summary This is the summary}
*/
// violation 2 lines above 'Summary of Javadoc is missing an ending period'
public void testHtmlTags4() {
}

Expand Down
Loading