diff --git a/config/archunit-store/slices_should_be_free_of_cycles_suppressions b/config/archunit-store/slices_should_be_free_of_cycles_suppressions index 13f4dd7d5b0..ba721b27aba 100644 --- a/config/archunit-store/slices_should_be_free_of_cycles_suppressions +++ b/config/archunit-store/slices_should_be_free_of_cycles_suppressions @@ -743,36 +743,36 @@ Cycle detected: Slice api -> \ - Method has parameter of type in (WriteTagCheck.java:0)\ - Constructor ()> calls constructor ()> in (AbstractJavadocCheck.java:50)\ - Constructor ()> calls constructor ()> in (InvalidJavadocPositionCheck.java:72)\ - - Constructor ()> calls constructor ()> in (MissingJavadocPackageCheck.java:74)\ - Method calls method in (JavadocTagInfo.java:76)\ + - Constructor ()> calls constructor ()> in (MissingJavadocPackageCheck.java:78)\ - Method calls method in (JavadocTagInfo.java:90)\ - Method calls method in (JavadocTagInfo.java:104)\ - Constructor ()> calls constructor ()> in (JavadocPackageCheck.java:109)\ - Method calls method in (JavadocTagInfo.java:118)\ - Method calls method in (JavadocMissingWhitespaceAfterAsteriskCheck.java:120)\ - - Method calls method in (MissingJavadocPackageCheck.java:120)\ - - Method calls method in (MissingJavadocPackageCheck.java:121)\ - Method calls constructor (java.lang.String, java.lang.Throwable)> in (JavadocPackageCheck.java:124)\ + - Method calls method in (MissingJavadocPackageCheck.java:124)\ + - Method calls method in (MissingJavadocPackageCheck.java:125)\ - Method calls method in (JavadocMissingWhitespaceAfterAsteriskCheck.java:127)\ - Method calls method in (JavadocMissingWhitespaceAfterAsteriskCheck.java:128)\ - Method calls method in (JavadocTagInfo.java:132)\ - - Method calls method in (MissingJavadocPackageCheck.java:132)\ - - Method references method in (MissingJavadocPackageCheck.java:132)\ - Method calls method in (JavadocMissingWhitespaceAfterAsteriskCheck.java:133)\ - Method calls method in (JavadocMissingWhitespaceAfterAsteriskCheck.java:133)\ - - Method references method in (MissingJavadocPackageCheck.java:133)\ - - Method calls method in (MissingJavadocPackageCheck.java:138)\ + - Method calls method in (MissingJavadocPackageCheck.java:136)\ + - Method references method in (MissingJavadocPackageCheck.java:136)\ + - Method references method in (MissingJavadocPackageCheck.java:137)\ + - Method calls method in (MissingJavadocPackageCheck.java:142)\ - Method calls method in (JavadocTagInfo.java:145)\ - Method calls method in (JavadocTagInfo.java:148)\ - Method calls method in (JavadocTagInfo.java:149)\ - Method gets field in (JavadocTagInfo.java:150)\ - Method calls method in (JavadocMissingLeadingAsteriskCheck.java:151)\ - Constructor ()> calls constructor ()> in (JavadocContentLocationCheck.java:154)\ - - Method calls method in (MissingJavadocPackageCheck.java:155)\ - Method calls method in (NonEmptyAtclauseDescriptionCheck.java:155)\ - Method calls method in (NonEmptyAtclauseDescriptionCheck.java:156)\ - Method calls method in (NonEmptyAtclauseDescriptionCheck.java:156)\ - Method calls method in (JavadocMissingLeadingAsteriskCheck.java:157)\ + - Method calls method in (MissingJavadocPackageCheck.java:159)\ - Method calls method in (JavadocTagInfo.java:162)\ - Method calls method in (RequireEmptyLineBeforeBlockTagGroupCheck.java:163)\ - Method calls method in (RequireEmptyLineBeforeBlockTagGroupCheck.java:165)\ @@ -886,7 +886,7 @@ Cycle detected: Slice api -> \ - Method calls method in (JavadocTagInfo.java:291)\ - Method calls method in (JavadocTagInfo.java:292)\ - Method calls method in (JavadocTagInfo.java:292)\ - - Constructor ()> calls constructor ()> in (JavadocStyleCheck.java:304)\ + - Constructor ()> calls constructor ()> in (JavadocStyleCheck.java:300)\ - Method calls method in (JavadocTagInfo.java:304)\ - Method calls method in (SingleLineJavadocCheck.java:305)\ - Method calls method in (AbstractJavadocCheck.java:308)\ @@ -901,10 +901,10 @@ Cycle detected: Slice api -> \ - Method calls method in (JavadocTagInfo.java:332)\ - Method calls method in (SummaryJavadocCheck.java:335)\ - Method calls method in (WriteTagCheck.java:335)\ + - Constructor ()> gets field in (JavadocStyleCheck.java:340)\ - Method calls method in (SummaryJavadocCheck.java:341)\ - Method calls method in (SummaryJavadocCheck.java:345)\ - Method calls method in (JavadocTagInfo.java:346)\ - - Constructor ()> gets field in (JavadocStyleCheck.java:347)\ - Method calls method in (SummaryJavadocCheck.java:357)\ - Method calls method in (JavadocTypeCheck.java:368)\ - Method calls method in (JavadocTypeCheck.java:369)\ @@ -919,26 +919,26 @@ Cycle detected: Slice api -> \ - Method calls method in (MissingJavadocMethodCheck.java:397)\ - Method calls method in (SummaryJavadocCheck.java:397)\ - Method calls method in (AbstractJavadocCheck.java:400)\ + - Method calls method in (JavadocStyleCheck.java:401)\ + - Method calls method in (JavadocStyleCheck.java:401)\ + - Method calls method in (JavadocStyleCheck.java:401)\ - Method calls method in (MissingJavadocMethodCheck.java:401)\ - Method calls method in (SummaryJavadocCheck.java:402)\ - Method calls method in (SummaryJavadocCheck.java:404)\ - - Method calls method in (JavadocStyleCheck.java:408)\ - - Method calls method in (JavadocStyleCheck.java:408)\ - - Method calls method in (JavadocStyleCheck.java:408)\ - Method calls method in (JavadocTypeCheck.java:411)\ - Method calls method in (JavadocTypeCheck.java:412)\ - Method calls method in (JavadocTypeCheck.java:414)\ + - Method calls method in (JavadocStyleCheck.java:416)\ - Method calls method in (JavadocTypeCheck.java:416)\ - - Method calls method in (JavadocStyleCheck.java:423)\ + - Method calls method in (JavadocStyleCheck.java:423)\ + - Method calls method in (JavadocStyleCheck.java:424)\ - Method calls method in (SummaryJavadocCheck.java:425)\ + - Method calls method in (JavadocStyleCheck.java:426)\ - Method calls method in (SummaryJavadocCheck.java:426)\ - Method calls method in (MissingJavadocMethodCheck.java:427)\ + - Method calls method in (JavadocStyleCheck.java:428)\ - Method calls method in (MissingJavadocMethodCheck.java:428)\ - Method calls method in (MissingJavadocMethodCheck.java:429)\ - - Method calls method in (JavadocStyleCheck.java:430)\ - - Method calls method in (JavadocStyleCheck.java:431)\ - - Method calls method in (JavadocStyleCheck.java:433)\ - - Method calls method in (JavadocStyleCheck.java:435)\ - Method calls method in (SummaryJavadocCheck.java:440)\ - Method calls method in (SummaryJavadocCheck.java:443)\ - Method calls method in (MissingJavadocMethodCheck.java:444)\ @@ -948,22 +948,22 @@ Cycle detected: Slice api -> \ - Method calls method in (SummaryJavadocCheck.java:450)\ - Method calls method in (SummaryJavadocCheck.java:452)\ - Method calls method in (MissingJavadocMethodCheck.java:468)\ + - Method calls method in (JavadocStyleCheck.java:469)\ - Method calls method in (MissingJavadocMethodCheck.java:469)\ + - Method calls method in (JavadocStyleCheck.java:475)\ - Method calls method in (JavadocMethodCheck.java:476)\ - Method calls method in (JavadocMethodCheck.java:477)\ - Method calls method in (JavadocMethodCheck.java:478)\ - Method calls method in (JavadocMethodCheck.java:479)\ - - Method calls method in (JavadocStyleCheck.java:485)\ + - Method calls method in (JavadocStyleCheck.java:485)\ - Method calls method in (SummaryJavadocCheck.java:487)\ + - Method calls method in (JavadocStyleCheck.java:488)\ - Method calls method in (JavadocMethodCheck.java:489)\ - Method calls method in (JavadocMethodCheck.java:490)\ - Method calls method in (JavadocMethodCheck.java:491)\ - - Method calls method in (JavadocStyleCheck.java:491)\ - Method calls method in (JavadocMethodCheck.java:492)\ - Method calls method in (SummaryJavadocCheck.java:492)\ - Method calls method in (SummaryJavadocCheck.java:493)\ - - Method calls method in (JavadocStyleCheck.java:501)\ - - Method calls method in (JavadocStyleCheck.java:504)\ - Method calls method in (SummaryJavadocCheck.java:505)\ - Method calls method in (SummaryJavadocCheck.java:509)\ - Method calls method in (JavadocMethodCheck.java:510)\ @@ -983,8 +983,8 @@ Cycle detected: Slice api -> \ - Method calls method in (JavadocTypeCheck.java:569)\ - Method calls method in (JavadocTypeCheck.java:575)\ - Method calls method in (JavadocTypeCheck.java:576)\ - - Method calls method in (JavadocStyleCheck.java:605)\ - - Method calls method in (JavadocStyleCheck.java:607)\ + - Method calls method in (JavadocStyleCheck.java:589)\ + - Method calls method in (JavadocStyleCheck.java:591)\ - Method calls method in (JavadocMethodCheck.java:609)\ - Method calls method in (JavadocMethodCheck.java:611)\ - Method calls method in (JavadocMethodCheck.java:612)\ @@ -1772,36 +1772,36 @@ Cycle detected: Slice api -> \ - Method has parameter of type in (WriteTagCheck.java:0)\ - Constructor ()> calls constructor ()> in (AbstractJavadocCheck.java:50)\ - Constructor ()> calls constructor ()> in (InvalidJavadocPositionCheck.java:72)\ - - Constructor ()> calls constructor ()> in (MissingJavadocPackageCheck.java:74)\ - Method calls method in (JavadocTagInfo.java:76)\ + - Constructor ()> calls constructor ()> in (MissingJavadocPackageCheck.java:78)\ - Method calls method in (JavadocTagInfo.java:90)\ - Method calls method in (JavadocTagInfo.java:104)\ - Constructor ()> calls constructor ()> in (JavadocPackageCheck.java:109)\ - Method calls method in (JavadocTagInfo.java:118)\ - Method calls method in (JavadocMissingWhitespaceAfterAsteriskCheck.java:120)\ - - Method calls method in (MissingJavadocPackageCheck.java:120)\ - - Method calls method in (MissingJavadocPackageCheck.java:121)\ - Method calls constructor (java.lang.String, java.lang.Throwable)> in (JavadocPackageCheck.java:124)\ + - Method calls method in (MissingJavadocPackageCheck.java:124)\ + - Method calls method in (MissingJavadocPackageCheck.java:125)\ - Method calls method in (JavadocMissingWhitespaceAfterAsteriskCheck.java:127)\ - Method calls method in (JavadocMissingWhitespaceAfterAsteriskCheck.java:128)\ - Method calls method in (JavadocTagInfo.java:132)\ - - Method calls method in (MissingJavadocPackageCheck.java:132)\ - - Method references method in (MissingJavadocPackageCheck.java:132)\ - Method calls method in (JavadocMissingWhitespaceAfterAsteriskCheck.java:133)\ - Method calls method in (JavadocMissingWhitespaceAfterAsteriskCheck.java:133)\ - - Method references method in (MissingJavadocPackageCheck.java:133)\ - - Method calls method in (MissingJavadocPackageCheck.java:138)\ + - Method calls method in (MissingJavadocPackageCheck.java:136)\ + - Method references method in (MissingJavadocPackageCheck.java:136)\ + - Method references method in (MissingJavadocPackageCheck.java:137)\ + - Method calls method in (MissingJavadocPackageCheck.java:142)\ - Method calls method in (JavadocTagInfo.java:145)\ - Method calls method in (JavadocTagInfo.java:148)\ - Method calls method in (JavadocTagInfo.java:149)\ - Method gets field in (JavadocTagInfo.java:150)\ - Method calls method in (JavadocMissingLeadingAsteriskCheck.java:151)\ - Constructor ()> calls constructor ()> in (JavadocContentLocationCheck.java:154)\ - - Method calls method in (MissingJavadocPackageCheck.java:155)\ - Method calls method in (NonEmptyAtclauseDescriptionCheck.java:155)\ - Method calls method in (NonEmptyAtclauseDescriptionCheck.java:156)\ - Method calls method in (NonEmptyAtclauseDescriptionCheck.java:156)\ - Method calls method in (JavadocMissingLeadingAsteriskCheck.java:157)\ + - Method calls method in (MissingJavadocPackageCheck.java:159)\ - Method calls method in (JavadocTagInfo.java:162)\ - Method calls method in (RequireEmptyLineBeforeBlockTagGroupCheck.java:163)\ - Method calls method in (RequireEmptyLineBeforeBlockTagGroupCheck.java:165)\ @@ -1915,7 +1915,7 @@ Cycle detected: Slice api -> \ - Method calls method in (JavadocTagInfo.java:291)\ - Method calls method in (JavadocTagInfo.java:292)\ - Method calls method in (JavadocTagInfo.java:292)\ - - Constructor ()> calls constructor ()> in (JavadocStyleCheck.java:304)\ + - Constructor ()> calls constructor ()> in (JavadocStyleCheck.java:300)\ - Method calls method in (JavadocTagInfo.java:304)\ - Method calls method in (SingleLineJavadocCheck.java:305)\ - Method calls method in (AbstractJavadocCheck.java:308)\ @@ -1930,10 +1930,10 @@ Cycle detected: Slice api -> \ - Method calls method in (JavadocTagInfo.java:332)\ - Method calls method in (SummaryJavadocCheck.java:335)\ - Method calls method in (WriteTagCheck.java:335)\ + - Constructor ()> gets field in (JavadocStyleCheck.java:340)\ - Method calls method in (SummaryJavadocCheck.java:341)\ - Method calls method in (SummaryJavadocCheck.java:345)\ - Method calls method in (JavadocTagInfo.java:346)\ - - Constructor ()> gets field in (JavadocStyleCheck.java:347)\ - Method calls method in (SummaryJavadocCheck.java:357)\ - Method calls method in (JavadocTypeCheck.java:368)\ - Method calls method in (JavadocTypeCheck.java:369)\ @@ -1948,26 +1948,26 @@ Cycle detected: Slice api -> \ - Method calls method in (MissingJavadocMethodCheck.java:397)\ - Method calls method in (SummaryJavadocCheck.java:397)\ - Method calls method in (AbstractJavadocCheck.java:400)\ + - Method calls method in (JavadocStyleCheck.java:401)\ + - Method calls method in (JavadocStyleCheck.java:401)\ + - Method calls method in (JavadocStyleCheck.java:401)\ - Method calls method in (MissingJavadocMethodCheck.java:401)\ - Method calls method in (SummaryJavadocCheck.java:402)\ - Method calls method in (SummaryJavadocCheck.java:404)\ - - Method calls method in (JavadocStyleCheck.java:408)\ - - Method calls method in (JavadocStyleCheck.java:408)\ - - Method calls method in (JavadocStyleCheck.java:408)\ - Method calls method in (JavadocTypeCheck.java:411)\ - Method calls method in (JavadocTypeCheck.java:412)\ - Method calls method in (JavadocTypeCheck.java:414)\ + - Method calls method in (JavadocStyleCheck.java:416)\ - Method calls method in (JavadocTypeCheck.java:416)\ - - Method calls method in (JavadocStyleCheck.java:423)\ + - Method calls method in (JavadocStyleCheck.java:423)\ + - Method calls method in (JavadocStyleCheck.java:424)\ - Method calls method in (SummaryJavadocCheck.java:425)\ + - Method calls method in (JavadocStyleCheck.java:426)\ - Method calls method in (SummaryJavadocCheck.java:426)\ - Method calls method in (MissingJavadocMethodCheck.java:427)\ + - Method calls method in (JavadocStyleCheck.java:428)\ - Method calls method in (MissingJavadocMethodCheck.java:428)\ - Method calls method in (MissingJavadocMethodCheck.java:429)\ - - Method calls method in (JavadocStyleCheck.java:430)\ - - Method calls method in (JavadocStyleCheck.java:431)\ - - Method calls method in (JavadocStyleCheck.java:433)\ - - Method calls method in (JavadocStyleCheck.java:435)\ - Method calls method in (SummaryJavadocCheck.java:440)\ - Method calls method in (SummaryJavadocCheck.java:443)\ - Method calls method in (MissingJavadocMethodCheck.java:444)\ @@ -1977,22 +1977,22 @@ Cycle detected: Slice api -> \ - Method calls method in (SummaryJavadocCheck.java:450)\ - Method calls method in (SummaryJavadocCheck.java:452)\ - Method calls method in (MissingJavadocMethodCheck.java:468)\ + - Method calls method in (JavadocStyleCheck.java:469)\ - Method calls method in (MissingJavadocMethodCheck.java:469)\ + - Method calls method in (JavadocStyleCheck.java:475)\ - Method calls method in (JavadocMethodCheck.java:476)\ - Method calls method in (JavadocMethodCheck.java:477)\ - Method calls method in (JavadocMethodCheck.java:478)\ - Method calls method in (JavadocMethodCheck.java:479)\ - - Method calls method in (JavadocStyleCheck.java:485)\ + - Method calls method in (JavadocStyleCheck.java:485)\ - Method calls method in (SummaryJavadocCheck.java:487)\ + - Method calls method in (JavadocStyleCheck.java:488)\ - Method calls method in (JavadocMethodCheck.java:489)\ - Method calls method in (JavadocMethodCheck.java:490)\ - Method calls method in (JavadocMethodCheck.java:491)\ - - Method calls method in (JavadocStyleCheck.java:491)\ - Method calls method in (JavadocMethodCheck.java:492)\ - Method calls method in (SummaryJavadocCheck.java:492)\ - Method calls method in (SummaryJavadocCheck.java:493)\ - - Method calls method in (JavadocStyleCheck.java:501)\ - - Method calls method in (JavadocStyleCheck.java:504)\ - Method calls method in (SummaryJavadocCheck.java:505)\ - Method calls method in (SummaryJavadocCheck.java:509)\ - Method calls method in (JavadocMethodCheck.java:510)\ @@ -2012,8 +2012,8 @@ Cycle detected: Slice api -> \ - Method calls method in (JavadocTypeCheck.java:569)\ - Method calls method in (JavadocTypeCheck.java:575)\ - Method calls method in (JavadocTypeCheck.java:576)\ - - Method calls method in (JavadocStyleCheck.java:605)\ - - Method calls method in (JavadocStyleCheck.java:607)\ + - Method calls method in (JavadocStyleCheck.java:589)\ + - Method calls method in (JavadocStyleCheck.java:591)\ - Method calls method in (JavadocMethodCheck.java:609)\ - Method calls method in (JavadocMethodCheck.java:611)\ - Method calls method in (JavadocMethodCheck.java:612)\ @@ -2545,17 +2545,17 @@ Cycle detected: Slice checks.javadoc -> \ - Method calls method in (JavadocTagInfo.java:78)\ - Method calls method in (JavadocTagInfo.java:92)\ - Method calls method in (InvalidJavadocPositionCheck.java:104)\ - - Method calls method in (MissingJavadocPackageCheck.java:104)\ - Method calls method in (InvalidJavadocPositionCheck.java:106)\ - Method calls method in (JavadocTagInfo.java:106)\ - Method calls method in (InvalidJavadocPositionCheck.java:107)\ + - Method calls method in (MissingJavadocPackageCheck.java:108)\ - Method calls method in (JavadocTagInfo.java:120)\ - Method calls method in (JavadocMissingWhitespaceAfterAsteriskCheck.java:121)\ - Method calls method in (JavadocMissingWhitespaceAfterAsteriskCheck.java:124)\ - Method gets field in (AbstractJavadocCheck.java:144)\ - Method calls method in (JavadocTagInfo.java:150)\ - Method calls method in (JavadocMissingLeadingAsteriskCheck.java:151)\ - - Method calls method in (MissingJavadocPackageCheck.java:155)\ + - Method calls method in (MissingJavadocPackageCheck.java:159)\ - Method calls method in (JavadocTagInfo.java:164)\ - Method calls method in (JavadocMissingLeadingAsteriskCheck.java:168)\ - Method calls method in (NonEmptyAtclauseDescriptionCheck.java:168)\ @@ -2641,7 +2641,7 @@ Cycle detected: Slice checks.javadoc -> \ - Method calls method in (AbstractJavadocCheck.java:376)\ - Method calls method in (JavadocTypeCheck.java:381)\ - Method calls method in (SummaryJavadocCheck.java:383)\ - - Method gets field in (JavadocStyleCheck.java:395)\ + - Method gets field in (JavadocStyleCheck.java:388)\ - Method calls method in (SummaryJavadocCheck.java:396)\ - Method calls method in (SummaryJavadocCheck.java:398)\ - Method calls method in (JavadocTypeCheck.java:408)\ @@ -2649,15 +2649,14 @@ Cycle detected: Slice checks.javadoc -> \ - Method calls method in (SummaryJavadocCheck.java:413)\ - Method calls method in (MissingJavadocMethodCheck.java:414)\ - Method calls method in (MissingJavadocMethodCheck.java:414)\ + - Method calls method in (JavadocStyleCheck.java:417)\ - Method calls method in (JavadocTypeCheck.java:417)\ - - Method calls method in (JavadocStyleCheck.java:424)\ - - Method calls method in (JavadocStyleCheck.java:426)\ - - Method calls method in (JavadocStyleCheck.java:427)\ + - Method calls method in (JavadocStyleCheck.java:419)\ + - Method calls method in (JavadocStyleCheck.java:420)\ + - Method calls method in (JavadocStyleCheck.java:421)\ - Method calls method in (JavadocTypeCheck.java:427)\ - Method gets field in (JavadocTypeCheck.java:427)\ - - Method calls method in (JavadocStyleCheck.java:428)\ - Method calls method in (MissingJavadocMethodCheck.java:431)\ - - Method calls method in (JavadocStyleCheck.java:455)\ - Method calls method in (MissingJavadocMethodCheck.java:463)\ - Method calls method in (JavadocMethodCheck.java:526)\ - Method calls method in (JavadocMethodCheck.java:528)\ @@ -2665,7 +2664,7 @@ Cycle detected: Slice checks.javadoc -> \ - Method calls method in (JavadocMethodCheck.java:556)\ - Method calls method in (JavadocMethodCheck.java:565)\ - Method calls method in (JavadocTypeCheck.java:573)\ - - Method calls method in (JavadocStyleCheck.java:649)\ + - Method calls method in (JavadocStyleCheck.java:633)\ - Method calls method in (SummaryJavadocCheck.java:657)\ - Method calls method in (SummaryJavadocCheck.java:684)\ - Method calls method in (SummaryJavadocCheck.java:707)\ diff --git a/src/it/java/org/checkstyle/suppressionxpathfilter/XpathRegressionJavadocStyleTest.java b/src/it/java/org/checkstyle/suppressionxpathfilter/XpathRegressionJavadocStyleTest.java deleted file mode 100644 index 026763222cd..00000000000 --- a/src/it/java/org/checkstyle/suppressionxpathfilter/XpathRegressionJavadocStyleTest.java +++ /dev/null @@ -1,60 +0,0 @@ -/////////////////////////////////////////////////////////////////////////////////////////////// -// checkstyle: Checks Java source code and other text files for adherence to a set of rules. -// Copyright (C) 2001-2022 the original author or authors. -// -// This library is free software; you can redistribute it and/or -// modify it under the terms of the GNU Lesser General Public -// License as published by the Free Software Foundation; either -// version 2.1 of the License, or (at your option) any later version. -// -// This library is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public -// License along with this library; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -/////////////////////////////////////////////////////////////////////////////////////////////// - -package org.checkstyle.suppressionxpathfilter; - -import java.io.File; -import java.util.Arrays; -import java.util.List; - -import org.junit.jupiter.api.Test; - -import com.puppycrawl.tools.checkstyle.DefaultConfiguration; -import com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck; - -public class XpathRegressionJavadocStyleTest extends AbstractXpathTestSupport { - - private final String checkName = JavadocStyleCheck.class.getSimpleName(); - - @Override - protected String getCheckName() { - return checkName; - } - - @Test - public void testOne() throws Exception { - final File fileToProcess = new File(getPath("SuppressionXpathRegression" - + File.separator + "package-info.java")); - - final DefaultConfiguration moduleConfig = - createModuleConfig(JavadocStyleCheck.class); - - final String[] expectedViolation = { - "1:1: " + getCheckMessage(JavadocStyleCheck.class, - JavadocStyleCheck.MSG_JAVADOC_MISSING), - }; - - final List expectedXpathQueries = Arrays.asList( - "/COMPILATION_UNIT", "/COMPILATION_UNIT/PACKAGE_DEF" - ); - - runVerifications(moduleConfig, fileToProcess, expectedViolation, - expectedXpathQueries); - } -} diff --git a/src/it/resources/org/checkstyle/suppressionxpathfilter/javadocstyle/SuppressionXpathRegression/package-info.java b/src/it/resources/org/checkstyle/suppressionxpathfilter/javadocstyle/SuppressionXpathRegression/package-info.java deleted file mode 100644 index c5286094295..00000000000 --- a/src/it/resources/org/checkstyle/suppressionxpathfilter/javadocstyle/SuppressionXpathRegression/package-info.java +++ /dev/null @@ -1 +0,0 @@ -package org.checkstyle.suppressionxpathfilter.javadocstyle.SuppressionXpathRegression; //warn diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java index 826833f446e..7b4f56db66d 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java @@ -66,8 +66,7 @@ * a previous open tag. * *
  • - * Check that a package Javadoc comment is well-formed (as described above) and - * NOT missing from any package-info.java files. + * Check that a package Javadoc comment is well-formed (as described above). *
    • *
  • * Check for allowed HTML tags. The list of allowed HTML tags is @@ -288,9 +287,6 @@ * {@code javadoc.incompleteTag} *
    • *
  • - * {@code javadoc.missing} - *
    • - *
  • * {@code javadoc.noPeriod} *
    • *
  • @@ -304,9 +300,6 @@ public class JavadocStyleCheck extends AbstractCheck { - /** Message property key for the Missing Javadoc message. */ - public static final String MSG_JAVADOC_MISSING = "javadoc.missing"; - /** Message property key for the Empty Javadoc message. */ public static final String MSG_EMPTY = "javadoc.empty"; @@ -447,16 +440,7 @@ else if (!ScopeUtil.isInCodeBlock(ast)) { * @see #checkHtmlTags(DetailAST, TextBlock) */ private void checkComment(final DetailAST ast, final TextBlock comment) { - if (comment == null) { - // checking for missing docs in JavadocStyleCheck is not consistent - // with the rest of CheckStyle... Even though, I didn't think it - // made sense to make another check just to ensure that the - // package-info.java file actually contains package Javadocs. - if (CheckUtil.isPackageInfo(getFilePath())) { - log(ast, MSG_JAVADOC_MISSING); - } - } - else { + if (comment != null) { if (checkFirstSentence) { checkFirstSentenceEnding(ast, comment); } diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/MissingJavadocPackageCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/MissingJavadocPackageCheck.java index 5216a2c21df..ee95776aad5 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/MissingJavadocPackageCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/MissingJavadocPackageCheck.java @@ -30,7 +30,7 @@ /** *

    - * Checks for missing Javadoc comments in package-info.java files. + * Checks for missing package definition Javadoc comments in package-info.java files. *

    *

    * Rationale: description and other related documentation for a package can be written up @@ -40,6 +40,10 @@ * >link for more info. *

    *

    + * This check specifically only validates package definitions. It will not validate any methods or + * interfaces declared in the package-info.java file. + *

    + *

    * To configure the check: *

    * 
    diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/javadoc/JavadocStyleCheck.xml b/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/javadoc/JavadocStyleCheck.xml
index 52308cabed0..5cbfe8b5f19 100644
--- a/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/javadoc/JavadocStyleCheck.xml
+++ b/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/javadoc/JavadocStyleCheck.xml
@@ -31,8 +31,7 @@
  a previous open tag.
  </li>
  <li>
- Check that a package Javadoc comment is well-formed (as described above) and
- NOT missing from any package-info.java files.
+ Check that a package Javadoc comment is well-formed (as described above).
  </li>
  <li>
  Check for allowed HTML tags. The list of allowed HTML tags is
@@ -87,7 +86,6 @@
             
             
             
-            
             
             
          
diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/javadoc/MissingJavadocPackageCheck.xml b/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/javadoc/MissingJavadocPackageCheck.xml
index 8af7207820d..01bc30cd3a7 100644
--- a/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/javadoc/MissingJavadocPackageCheck.xml
+++ b/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/javadoc/MissingJavadocPackageCheck.xml
@@ -5,7 +5,7 @@
               name="MissingJavadocPackage"
               parent="com.puppycrawl.tools.checkstyle.TreeWalker">
          <p>
- Checks for missing Javadoc comments in package-info.java files.
+ Checks for missing package definition Javadoc comments in package-info.java files.
  </p>
  <p>
  Rationale: description and other related documentation for a package can be written up
@@ -13,6 +13,10 @@
  See <a
  href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#packagecomment"
  >link</a> for more info.
+ </p>
+ <p>
+ This check specifically only validates package definitions. It will not validate any methods or
+ interfaces declared in the package-info.java file.
  </p>
          
             
diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java
index c998d0ab9a3..9608cf30fb6 100644
--- a/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java
+++ b/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java
@@ -23,7 +23,6 @@
 import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.MSG_EMPTY;
 import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.MSG_EXTRA_HTML;
 import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.MSG_INCOMPLETE_TAG;
-import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.MSG_JAVADOC_MISSING;
 import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.MSG_NO_PERIOD;
 import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.MSG_UNCLOSED_HTML;
 
@@ -485,12 +484,21 @@ public void packageInfoAnnotation() throws Exception {
 
     @Test
     public void packageInfoMissing() throws Exception {
+        final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
+
+        verifyWithInlineConfigParser(
+                getPath("bothfiles" + File.separator + "package-info.java"),
+               expected);
+    }
+
+    @Test
+    public void packageInfoMissingPeriod() throws Exception {
         final String[] expected = {
-            "16:1: " + getCheckMessage(MSG_JAVADOC_MISSING),
+            "16: " + getCheckMessage(MSG_NO_PERIOD),
         };
 
         verifyWithInlineConfigParser(
-                getPath("bothfiles" + File.separator + "package-info.java"),
+                getPath("missingperiod" + File.separator + "package-info.java"),
                expected);
     }
 
diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/utils/CheckUtilTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/utils/CheckUtilTest.java
index b04e4a6ca27..443ef9d6523 100644
--- a/src/test/java/com/puppycrawl/tools/checkstyle/utils/CheckUtilTest.java
+++ b/src/test/java/com/puppycrawl/tools/checkstyle/utils/CheckUtilTest.java
@@ -24,6 +24,7 @@
 import static com.puppycrawl.tools.checkstyle.internal.utils.TestUtil.isUtilsClassHasPrivateConstructor;
 
 import java.io.File;
+import java.io.IOException;
 import java.util.Arrays;
 import java.util.HashSet;
 import java.util.List;
@@ -443,6 +444,20 @@ public void testParseClassNames() {
             .isEqualTo(expected);
     }
 
+    @Test
+    public void testIsPackageInfo() throws IOException {
+        assertWithMessage("Result is expected")
+            .that(CheckUtil.isPackageInfo(getPath("package-info.java")))
+            .isEqualTo(true);
+    }
+
+    @Test
+    public void testIsPackageInfoBad() throws IOException {
+        assertWithMessage("Result is expected")
+            .that(CheckUtil.isPackageInfo(getPath("InputCheckUtilPackage.java")))
+            .isEqualTo(false);
+    }
+
     private DetailAST getNodeFromFile(int type) throws Exception {
         return getNode(JavaParser.parseFile(new File(getPath("InputCheckUtilTest.java")),
             JavaParser.Options.WITH_COMMENTS), type);
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/bothfiles/package-info.java b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/bothfiles/package-info.java
index ac7e270353e..dd75e4e9465 100644
--- a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/bothfiles/package-info.java
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/bothfiles/package-info.java
@@ -13,4 +13,4 @@
 
 */
 
-package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocstyle.bothfiles; // violation
+package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocstyle.bothfiles;
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/missingperiod/package-info.java b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/missingperiod/package-info.java
new file mode 100644
index 00000000000..0de458e5cbf
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/missingperiod/package-info.java
@@ -0,0 +1,28 @@
+/*
+JavadocStyle
+scope = (default)private
+excludeScope = (default)null
+checkFirstSentence = (default)true
+endOfSentenceFormat = (default)([.?!][ \t\n\r\f<])|([.?!]$)
+checkEmptyJavadoc = (default)false
+checkHtml = (default)true
+tokens = (default)ANNOTATION_DEF, ANNOTATION_FIELD_DEF, CLASS_DEF, CTOR_DEF, \
+         ENUM_CONSTANT_DEF, ENUM_DEF, INTERFACE_DEF, METHOD_DEF, PACKAGE_DEF, \
+         VARIABLE_DEF, RECORD_DEF, COMPACT_CTOR_DEF
+
+
+*/
+
+/** Example */ // violation 'First sentence should end with a period.'
+@Example
+package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocstyle.missingperiod;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Retention(RetentionPolicy.CLASS)
+@Target(ElementType.PACKAGE)
+@interface Example {
+}
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/utils/checkutil/InputCheckUtilPackage.java b/src/test/resources/com/puppycrawl/tools/checkstyle/utils/checkutil/InputCheckUtilPackage.java
new file mode 100644
index 00000000000..711f2f47aa1
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/utils/checkutil/InputCheckUtilPackage.java
@@ -0,0 +1,4 @@
+package com.puppycrawl.tools.checkstyle.utils.checkutil; // ok
+
+public class InputCheckUtilPackage {
+}
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/utils/checkutil/package-info.java b/src/test/resources/com/puppycrawl/tools/checkstyle/utils/checkutil/package-info.java
new file mode 100644
index 00000000000..06ed024fb80
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/utils/checkutil/package-info.java
@@ -0,0 +1 @@
+package com.puppycrawl.tools.checkstyle.utils.checkutil; // ok
diff --git a/src/xdocs/checks.xml b/src/xdocs/checks.xml
index 070f0fa018b..fbde6b49bee 100644
--- a/src/xdocs/checks.xml
+++ b/src/xdocs/checks.xml
@@ -553,7 +553,9 @@
           
           
             MissingJavadocPackage
-            Checks for missing Javadoc comments in package-info.java files.
+            
+              Checks for missing package definition Javadoc comments in package-info.java files.
+            
           
           
             MissingJavadocType
diff --git a/src/xdocs/config_javadoc.xml b/src/xdocs/config_javadoc.xml
index aa980dd7f75..d37cb8b13db 100644
--- a/src/xdocs/config_javadoc.xml
+++ b/src/xdocs/config_javadoc.xml
@@ -1519,7 +1519,7 @@ public class TestClass {
  • Check that a package Javadoc comment is well-formed (as - described above) and NOT missing from any package-info.java files. + described above).
  • Check for allowed HTML tags. The list of allowed HTML tags @@ -1824,10 +1824,6 @@ public class Test { javadoc.incompleteTag
    • -
  • - - javadoc.missing -
  • javadoc.noPeriod @@ -2779,7 +2775,7 @@ public class Test {

    Since Checkstyle 8.22

    - Checks for missing Javadoc comments in package-info.java files. + Checks for missing package definition Javadoc comments in package-info.java files.

    @@ -2788,6 +2784,11 @@ public class Test { See link for more info.

    + +

    + This check specifically only validates package definitions. It will not validate any + methods or interfaces declared in the package-info.java file. +