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..4eefc6bfcd9 100644 --- a/config/archunit-store/slices_should_be_free_of_cycles_suppressions +++ b/config/archunit-store/slices_should_be_free_of_cycles_suppressions @@ -565,6 +565,7 @@ Cycle detected: Slice api -> \ - Field depends on component type in (JavadocNodeImpl.java:0)\ - Field has type in (JavadocNodeImpl.java:0)\ - Field has type in (JavadocStyleCheck.java:0)\ + - Field has type in (JavadocStyleCheck.java:0)\ - Field has type in (JavadocStyleCheck.java:0)\ - Field has type in (JavadocTypeCheck.java:0)\ - Field has type in (JavadocTypeCheck.java:0)\ @@ -647,6 +648,11 @@ Cycle detected: Slice api -> \ - Method has parameter of type in (JavadocStyleCheck.java:0)\ - Method has parameter of type in (JavadocStyleCheck.java:0)\ - Method has parameter of type in (JavadocStyleCheck.java:0)\ + - Method has return type in (JavadocStyleCheck.java:0)\ + - Method has parameter of type in (JavadocStyleCheck.java:0)\ + - Method has return type in (JavadocStyleCheck.java:0)\ + - Method has parameter of type in (JavadocStyleCheck.java:0)\ + - Method has parameter of type in (JavadocStyleCheck.java:0)\ - Method has parameter of type in (JavadocStyleCheck.java:0)\ - Method has parameter of type in (JavadocStyleCheck.java:0)\ - Method has parameter of type in (JavadocStyleCheck.java:0)\ @@ -886,9 +892,9 @@ 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)\ - Method calls method in (JavadocTagInfo.java:304)\ - Method calls method in (SingleLineJavadocCheck.java:305)\ + - Constructor ()> calls constructor ()> in (JavadocStyleCheck.java:307)\ - Method calls method in (AbstractJavadocCheck.java:308)\ - Method calls method in (JavadocParagraphCheck.java:308)\ - Method calls constructor (int, int)> in (AbstractJavadocCheck.java:309)\ @@ -904,7 +910,7 @@ Cycle detected: Slice api -> \ - 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)\ + - Constructor ()> gets field in (JavadocStyleCheck.java:350)\ - Method calls method in (SummaryJavadocCheck.java:357)\ - Method calls method in (JavadocTypeCheck.java:368)\ - Method calls method in (JavadocTypeCheck.java:369)\ @@ -922,23 +928,18 @@ Cycle detected: Slice api -> \ - 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 (JavadocStyleCheck.java:405)\ + - Method calls method in (JavadocStyleCheck.java:410)\ - 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 (JavadocTypeCheck.java:416)\ - - Method calls method in (JavadocStyleCheck.java:423)\ - Method calls method in (SummaryJavadocCheck.java:425)\ - Method calls method in (SummaryJavadocCheck.java:426)\ - Method calls method in (MissingJavadocMethodCheck.java:427)\ - 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 (JavadocStyleCheck.java:436)\ - Method calls method in (SummaryJavadocCheck.java:440)\ - Method calls method in (SummaryJavadocCheck.java:443)\ - Method calls method in (MissingJavadocMethodCheck.java:444)\ @@ -947,45 +948,86 @@ Cycle detected: Slice api -> \ - Method calls method in (SummaryJavadocCheck.java:448)\ - Method calls method in (SummaryJavadocCheck.java:450)\ - Method calls method in (SummaryJavadocCheck.java:452)\ + - Method calls method in (JavadocStyleCheck.java:458)\ + - Method calls method in (JavadocStyleCheck.java:460)\ + - Method calls method in (JavadocStyleCheck.java:463)\ + - Method calls method in (JavadocStyleCheck.java:464)\ + - Method calls method in (JavadocStyleCheck.java:464)\ + - Method calls method in (JavadocStyleCheck.java:464)\ + - Method calls method in (JavadocStyleCheck.java:465)\ + - Method calls method in (JavadocStyleCheck.java:465)\ + - Method calls method in (JavadocStyleCheck.java:465)\ + - Method calls method in (JavadocStyleCheck.java:466)\ - 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:472)\ + - Method calls method in (JavadocStyleCheck.java:473)\ - 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 (SummaryJavadocCheck.java:487)\ - 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 constructor ([Ljava.lang.String;, int, int, int)> in (JavadocStyleCheck.java:508)\ - Method calls method in (SummaryJavadocCheck.java:509)\ - Method calls method in (JavadocMethodCheck.java:510)\ - Method calls method in (JavadocMethodCheck.java:510)\ - Method calls method in (SummaryJavadocCheck.java:512)\ + - Method calls constructor ([Ljava.lang.String;, int, int, int)> in (JavadocStyleCheck.java:514)\ - Method calls method in (SummaryJavadocCheck.java:526)\ - Method calls method in (SummaryJavadocCheck.java:529)\ + - Method calls method in (JavadocStyleCheck.java:531)\ + - Method calls method in (JavadocStyleCheck.java:531)\ + - Method calls method in (JavadocStyleCheck.java:531)\ + - Method calls method in (JavadocStyleCheck.java:534)\ + - Method calls method in (JavadocStyleCheck.java:537)\ + - Method calls method in (JavadocStyleCheck.java:537)\ + - Method calls method in (JavadocStyleCheck.java:537)\ - Method calls method in (SummaryJavadocCheck.java:540)\ + - Method calls method in (JavadocStyleCheck.java:544)\ + - Method calls method in (JavadocStyleCheck.java:544)\ - Method calls method in (JavadocMethodCheck.java:545)\ + - Method calls method in (JavadocStyleCheck.java:545)\ + - Method calls method in (JavadocStyleCheck.java:545)\ + - Method calls method in (JavadocStyleCheck.java:545)\ - Method calls method in (SummaryJavadocCheck.java:545)\ - Method calls method in (JavadocMethodCheck.java:546)\ + - Method calls method in (JavadocStyleCheck.java:547)\ + - Method calls method in (JavadocStyleCheck.java:552)\ + - Method calls method in (JavadocStyleCheck.java:553)\ + - Method calls method in (JavadocStyleCheck.java:553)\ + - Method calls method in (JavadocStyleCheck.java:553)\ + - Method calls method in (JavadocStyleCheck.java:554)\ + - Method calls method in (JavadocStyleCheck.java:556)\ + - Method calls method in (JavadocStyleCheck.java:558)\ + - Method calls method in (JavadocStyleCheck.java:558)\ + - Method calls method in (JavadocStyleCheck.java:558)\ - Method calls method in (JavadocMethodCheck.java:559)\ + - Method calls method in (JavadocStyleCheck.java:559)\ + - Method calls method in (JavadocStyleCheck.java:561)\ - Method calls method in (SummaryJavadocCheck.java:561)\ - Method calls method in (SummaryJavadocCheck.java:563)\ - Method calls method in (JavadocMethodCheck.java:566)\ - Method calls method in (SummaryJavadocCheck.java:567)\ - Method calls method in (JavadocTypeCheck.java:569)\ + - Method calls method in (JavadocStyleCheck.java:571)\ + - Method calls method in (JavadocStyleCheck.java:572)\ - 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:597)\ + - Method calls method in (JavadocStyleCheck.java:598)\ + - Method calls method in (JavadocStyleCheck.java:604)\ + - Method calls method in (JavadocStyleCheck.java:605)\ + - Method calls method in (JavadocStyleCheck.java:607)\ - Method calls method in (JavadocMethodCheck.java:609)\ + - Method calls method in (JavadocStyleCheck.java:609)\ - Method calls method in (JavadocMethodCheck.java:611)\ - Method calls method in (JavadocMethodCheck.java:612)\ - Method calls method in (SummaryJavadocCheck.java:648)\ @@ -994,10 +1036,14 @@ Cycle detected: Slice api -> \ - Method calls method in (SummaryJavadocCheck.java:653)\ - Method calls method in (SummaryJavadocCheck.java:656)\ - Method calls method in (SummaryJavadocCheck.java:657)\ + - Method calls method in (JavadocStyleCheck.java:660)\ + - Method calls method in (JavadocStyleCheck.java:666)\ - Method calls method in (SummaryJavadocCheck.java:673)\ - Method calls method in (SummaryJavadocCheck.java:674)\ + - Method calls method in (JavadocStyleCheck.java:676)\ - Method calls method in (SummaryJavadocCheck.java:677)\ - Method calls method in (SummaryJavadocCheck.java:678)\ + - Method calls method in (JavadocStyleCheck.java:679)\ - Method calls method in (SummaryJavadocCheck.java:679)\ - Method calls method in (SummaryJavadocCheck.java:683)\ - Method calls method in (SummaryJavadocCheck.java:686)\ @@ -1020,7 +1066,9 @@ Cycle detected: Slice api -> \ - Method calls method in (JavadocMethodCheck.java:763)\ - Method calls method in (JavadocMethodCheck.java:764)\ - Method calls method in (JavadocMethodCheck.java:765)\ + - Method calls method in (JavadocStyleCheck.java:780)\ - Method calls method in (JavadocMethodCheck.java:781)\ + - Method calls method in (JavadocStyleCheck.java:782)\ - Method calls method in (JavadocMethodCheck.java:795)\ - Method calls method in (JavadocMethodCheck.java:796)\ - Method calls method in (JavadocMethodCheck.java:811)\ @@ -1046,9 +1094,7 @@ Cycle detected: Slice api -> \ - Method calls method in (JavadocMethodCheck.java:979)\ - Method calls method in (JavadocMethodCheck.java:1134)\ - Method calls method in (JavadocMethodCheck.java:1135)\ - - Constructor (com.puppycrawl.tools.checkstyle.api.FullIdent)> calls method in (JavadocMethodCheck.java:1201)\ - - Constructor (com.puppycrawl.tools.checkstyle.api.FullIdent)> calls method in (JavadocMethodCheck.java:1202)\ - - Constructor (com.puppycrawl.tools.checkstyle.api.FullIdent)> calls method in (JavadocMethodCheck.java:1203) + (3 further dependencies have been omitted...) Cycle detected: Slice api -> \ Slice checks.naming -> \ Slice utils -> \ @@ -1594,6 +1640,7 @@ Cycle detected: Slice api -> \ - Field depends on component type in (JavadocNodeImpl.java:0)\ - Field has type in (JavadocNodeImpl.java:0)\ - Field has type in (JavadocStyleCheck.java:0)\ + - Field has type in (JavadocStyleCheck.java:0)\ - Field has type in (JavadocStyleCheck.java:0)\ - Field has type in (JavadocTypeCheck.java:0)\ - Field has type in (JavadocTypeCheck.java:0)\ @@ -1676,6 +1723,11 @@ Cycle detected: Slice api -> \ - Method has parameter of type in (JavadocStyleCheck.java:0)\ - Method has parameter of type in (JavadocStyleCheck.java:0)\ - Method has parameter of type in (JavadocStyleCheck.java:0)\ + - Method has return type in (JavadocStyleCheck.java:0)\ + - Method has parameter of type in (JavadocStyleCheck.java:0)\ + - Method has return type in (JavadocStyleCheck.java:0)\ + - Method has parameter of type in (JavadocStyleCheck.java:0)\ + - Method has parameter of type in (JavadocStyleCheck.java:0)\ - Method has parameter of type in (JavadocStyleCheck.java:0)\ - Method has parameter of type in (JavadocStyleCheck.java:0)\ - Method has parameter of type in (JavadocStyleCheck.java:0)\ @@ -1915,9 +1967,9 @@ 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)\ - Method calls method in (JavadocTagInfo.java:304)\ - Method calls method in (SingleLineJavadocCheck.java:305)\ + - Constructor ()> calls constructor ()> in (JavadocStyleCheck.java:307)\ - Method calls method in (AbstractJavadocCheck.java:308)\ - Method calls method in (JavadocParagraphCheck.java:308)\ - Method calls constructor (int, int)> in (AbstractJavadocCheck.java:309)\ @@ -1933,7 +1985,7 @@ Cycle detected: Slice api -> \ - 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)\ + - Constructor ()> gets field in (JavadocStyleCheck.java:350)\ - Method calls method in (SummaryJavadocCheck.java:357)\ - Method calls method in (JavadocTypeCheck.java:368)\ - Method calls method in (JavadocTypeCheck.java:369)\ @@ -1951,23 +2003,18 @@ Cycle detected: Slice api -> \ - 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 (JavadocStyleCheck.java:405)\ + - Method calls method in (JavadocStyleCheck.java:410)\ - 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 (JavadocTypeCheck.java:416)\ - - Method calls method in (JavadocStyleCheck.java:423)\ - Method calls method in (SummaryJavadocCheck.java:425)\ - Method calls method in (SummaryJavadocCheck.java:426)\ - Method calls method in (MissingJavadocMethodCheck.java:427)\ - 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 (JavadocStyleCheck.java:436)\ - Method calls method in (SummaryJavadocCheck.java:440)\ - Method calls method in (SummaryJavadocCheck.java:443)\ - Method calls method in (MissingJavadocMethodCheck.java:444)\ @@ -1976,45 +2023,86 @@ Cycle detected: Slice api -> \ - Method calls method in (SummaryJavadocCheck.java:448)\ - Method calls method in (SummaryJavadocCheck.java:450)\ - Method calls method in (SummaryJavadocCheck.java:452)\ + - Method calls method in (JavadocStyleCheck.java:458)\ + - Method calls method in (JavadocStyleCheck.java:460)\ + - Method calls method in (JavadocStyleCheck.java:463)\ + - Method calls method in (JavadocStyleCheck.java:464)\ + - Method calls method in (JavadocStyleCheck.java:464)\ + - Method calls method in (JavadocStyleCheck.java:464)\ + - Method calls method in (JavadocStyleCheck.java:465)\ + - Method calls method in (JavadocStyleCheck.java:465)\ + - Method calls method in (JavadocStyleCheck.java:465)\ + - Method calls method in (JavadocStyleCheck.java:466)\ - 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:472)\ + - Method calls method in (JavadocStyleCheck.java:473)\ - 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 (SummaryJavadocCheck.java:487)\ - 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 constructor ([Ljava.lang.String;, int, int, int)> in (JavadocStyleCheck.java:508)\ - Method calls method in (SummaryJavadocCheck.java:509)\ - Method calls method in (JavadocMethodCheck.java:510)\ - Method calls method in (JavadocMethodCheck.java:510)\ - Method calls method in (SummaryJavadocCheck.java:512)\ + - Method calls constructor ([Ljava.lang.String;, int, int, int)> in (JavadocStyleCheck.java:514)\ - Method calls method in (SummaryJavadocCheck.java:526)\ - Method calls method in (SummaryJavadocCheck.java:529)\ + - Method calls method in (JavadocStyleCheck.java:531)\ + - Method calls method in (JavadocStyleCheck.java:531)\ + - Method calls method in (JavadocStyleCheck.java:531)\ + - Method calls method in (JavadocStyleCheck.java:534)\ + - Method calls method in (JavadocStyleCheck.java:537)\ + - Method calls method in (JavadocStyleCheck.java:537)\ + - Method calls method in (JavadocStyleCheck.java:537)\ - Method calls method in (SummaryJavadocCheck.java:540)\ + - Method calls method in (JavadocStyleCheck.java:544)\ + - Method calls method in (JavadocStyleCheck.java:544)\ - Method calls method in (JavadocMethodCheck.java:545)\ + - Method calls method in (JavadocStyleCheck.java:545)\ + - Method calls method in (JavadocStyleCheck.java:545)\ + - Method calls method in (JavadocStyleCheck.java:545)\ - Method calls method in (SummaryJavadocCheck.java:545)\ - Method calls method in (JavadocMethodCheck.java:546)\ + - Method calls method in (JavadocStyleCheck.java:547)\ + - Method calls method in (JavadocStyleCheck.java:552)\ + - Method calls method in (JavadocStyleCheck.java:553)\ + - Method calls method in (JavadocStyleCheck.java:553)\ + - Method calls method in (JavadocStyleCheck.java:553)\ + - Method calls method in (JavadocStyleCheck.java:554)\ + - Method calls method in (JavadocStyleCheck.java:556)\ + - Method calls method in (JavadocStyleCheck.java:558)\ + - Method calls method in (JavadocStyleCheck.java:558)\ + - Method calls method in (JavadocStyleCheck.java:558)\ - Method calls method in (JavadocMethodCheck.java:559)\ + - Method calls method in (JavadocStyleCheck.java:559)\ + - Method calls method in (JavadocStyleCheck.java:561)\ - Method calls method in (SummaryJavadocCheck.java:561)\ - Method calls method in (SummaryJavadocCheck.java:563)\ - Method calls method in (JavadocMethodCheck.java:566)\ - Method calls method in (SummaryJavadocCheck.java:567)\ - Method calls method in (JavadocTypeCheck.java:569)\ + - Method calls method in (JavadocStyleCheck.java:571)\ + - Method calls method in (JavadocStyleCheck.java:572)\ - 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:597)\ + - Method calls method in (JavadocStyleCheck.java:598)\ + - Method calls method in (JavadocStyleCheck.java:604)\ + - Method calls method in (JavadocStyleCheck.java:605)\ + - Method calls method in (JavadocStyleCheck.java:607)\ - Method calls method in (JavadocMethodCheck.java:609)\ + - Method calls method in (JavadocStyleCheck.java:609)\ - Method calls method in (JavadocMethodCheck.java:611)\ - Method calls method in (JavadocMethodCheck.java:612)\ - Method calls method in (SummaryJavadocCheck.java:648)\ @@ -2023,10 +2111,14 @@ Cycle detected: Slice api -> \ - Method calls method in (SummaryJavadocCheck.java:653)\ - Method calls method in (SummaryJavadocCheck.java:656)\ - Method calls method in (SummaryJavadocCheck.java:657)\ + - Method calls method in (JavadocStyleCheck.java:660)\ + - Method calls method in (JavadocStyleCheck.java:666)\ - Method calls method in (SummaryJavadocCheck.java:673)\ - Method calls method in (SummaryJavadocCheck.java:674)\ + - Method calls method in (JavadocStyleCheck.java:676)\ - Method calls method in (SummaryJavadocCheck.java:677)\ - Method calls method in (SummaryJavadocCheck.java:678)\ + - Method calls method in (JavadocStyleCheck.java:679)\ - Method calls method in (SummaryJavadocCheck.java:679)\ - Method calls method in (SummaryJavadocCheck.java:683)\ - Method calls method in (SummaryJavadocCheck.java:686)\ @@ -2049,7 +2141,9 @@ Cycle detected: Slice api -> \ - Method calls method in (JavadocMethodCheck.java:763)\ - Method calls method in (JavadocMethodCheck.java:764)\ - Method calls method in (JavadocMethodCheck.java:765)\ + - Method calls method in (JavadocStyleCheck.java:780)\ - Method calls method in (JavadocMethodCheck.java:781)\ + - Method calls method in (JavadocStyleCheck.java:782)\ - Method calls method in (JavadocMethodCheck.java:795)\ - Method calls method in (JavadocMethodCheck.java:796)\ - Method calls method in (JavadocMethodCheck.java:811)\ @@ -2075,9 +2169,7 @@ Cycle detected: Slice api -> \ - Method calls method in (JavadocMethodCheck.java:979)\ - Method calls method in (JavadocMethodCheck.java:1134)\ - Method calls method in (JavadocMethodCheck.java:1135)\ - - Constructor (com.puppycrawl.tools.checkstyle.api.FullIdent)> calls method in (JavadocMethodCheck.java:1201)\ - - Constructor (com.puppycrawl.tools.checkstyle.api.FullIdent)> calls method in (JavadocMethodCheck.java:1202)\ - - Constructor (com.puppycrawl.tools.checkstyle.api.FullIdent)> calls method in (JavadocMethodCheck.java:1203) + (3 further dependencies have been omitted...) Cycle detected: Slice api -> \ Slice utils -> \ Slice checks.javadoc -> \ @@ -2641,7 +2733,6 @@ 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 calls method in (SummaryJavadocCheck.java:396)\ - Method calls method in (SummaryJavadocCheck.java:398)\ - Method calls method in (JavadocTypeCheck.java:408)\ @@ -2650,25 +2741,31 @@ Cycle detected: Slice checks.javadoc -> \ - Method calls method in (MissingJavadocMethodCheck.java:414)\ - Method calls method in (MissingJavadocMethodCheck.java:414)\ - 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 gets field in (JavadocStyleCheck.java:420)\ - 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 (JavadocStyleCheck.java:461)\ + - Method calls method in (JavadocStyleCheck.java:462)\ - Method calls method in (MissingJavadocMethodCheck.java:463)\ - Method calls method in (JavadocMethodCheck.java:526)\ - Method calls method in (JavadocMethodCheck.java:528)\ - Method calls method in (SummaryJavadocCheck.java:547)\ + - Method calls method in (JavadocStyleCheck.java:554)\ + - Method calls method in (JavadocStyleCheck.java:555)\ - Method calls method in (JavadocMethodCheck.java:556)\ + - Method calls method in (JavadocStyleCheck.java:561)\ - 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:599)\ + - Method calls method in (JavadocStyleCheck.java:600)\ + - Method calls method in (JavadocStyleCheck.java:601)\ + - Method calls method in (JavadocStyleCheck.java:602)\ + - Method calls method in (JavadocStyleCheck.java:630)\ - Method calls method in (SummaryJavadocCheck.java:657)\ - Method calls method in (SummaryJavadocCheck.java:684)\ - Method calls method in (SummaryJavadocCheck.java:707)\ + - Method calls method in (JavadocStyleCheck.java:824)\ - Method calls method in (JavadocMethodCheck.java:896)\ - Method calls method in (JavadocMethodCheck.java:912)\ - Method calls method in (JavadocMethodCheck.java:912)\ diff --git a/config/suppressions.xml b/config/suppressions.xml index df84c8bcc9c..a7261a73026 100644 --- a/config/suppressions.xml +++ b/config/suppressions.xml @@ -105,7 +105,6 @@ - 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..080bf3b1586 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 @@ -29,13 +29,14 @@ import com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser; import com.puppycrawl.tools.checkstyle.StatelessCheck; import com.puppycrawl.tools.checkstyle.api.AbstractCheck; +import com.puppycrawl.tools.checkstyle.api.Comment; import com.puppycrawl.tools.checkstyle.api.DetailAST; -import com.puppycrawl.tools.checkstyle.api.FileContents; import com.puppycrawl.tools.checkstyle.api.Scope; import com.puppycrawl.tools.checkstyle.api.TextBlock; import com.puppycrawl.tools.checkstyle.api.TokenTypes; import com.puppycrawl.tools.checkstyle.utils.CheckUtil; import com.puppycrawl.tools.checkstyle.utils.CommonUtil; +import com.puppycrawl.tools.checkstyle.utils.JavadocUtil; import com.puppycrawl.tools.checkstyle.utils.ScopeUtil; /** @@ -147,7 +148,9 @@ * * RECORD_DEF, * - * COMPACT_CTOR_DEF. + * COMPACT_CTOR_DEF, + * + * COMMENT_CONTENT. * * *

@@ -367,6 +370,10 @@ public class JavadocStyleCheck */ private boolean checkEmptyJavadoc; + private TextBlock packageTextBlock = null; + + private boolean isFirstRun = true; + @Override public int[] getDefaultTokens() { return getAcceptableTokens(); @@ -387,28 +394,195 @@ public int[] getAcceptableTokens() { TokenTypes.VARIABLE_DEF, TokenTypes.RECORD_DEF, TokenTypes.COMPACT_CTOR_DEF, + TokenTypes.COMMENT_CONTENT }; } + private boolean isNewToken(DetailAST ast) { + int[] tokens = getAcceptableTokens(); + + for (int token : tokens) { + if (token == ast.getType()) { + return true; + } + } + + return ast.getType() == TokenTypes.OBJBLOCK; + } + + @Override + public boolean isCommentNodesRequired() { + return true; + } + @Override public int[] getRequiredTokens() { return CommonUtil.EMPTY_INT_ARRAY; } - // suppress deprecation until https://github.com/checkstyle/checkstyle/issues/11166 - @SuppressWarnings("deprecation") @Override public void visitToken(DetailAST ast) { + if (isFirstRun) { + isFirstRun = false; + getJavaDocForPackage(ast); + } + if (shouldCheck(ast)) { - final FileContents contents = getFileContents(); // Need to start searching for the comment before the annotations // that may exist. Even if annotations are not defined on the // package, the ANNOTATIONS AST is defined. - final TextBlock textBlock = - contents.getJavadocBefore(ast.getFirstChild().getLineNo()); + TextBlock newTextBlock; + + if (ast.getType() != TokenTypes.PACKAGE_DEF || packageTextBlock == null) { + newTextBlock = getJavaDoc(ast); + } else { + newTextBlock = packageTextBlock; + } + + checkComment(ast, newTextBlock); + } + } + + /** + * Get The Javadoc For Package Token. + * + * @param ast as Package Token + * @return TextBlock of Javadoc comment + */ + private void getJavaDocForPackage(DetailAST ast) { + DetailAST temp = ast; + String comment = null; + int startColNo = 0, endLineNo = 0, endColNo = 0, startLine = 0; + + while (temp != null) { + DetailAST toVisit = temp.getFirstChild(); + + if (temp.getType() == TokenTypes.BLOCK_COMMENT_BEGIN + && JavadocUtil.isJavadocComment(temp)) { + comment = JavadocUtil.getJavadocCommentContent(temp); + startColNo = temp.getColumnNo(); + endLineNo = temp.getFirstChild().getNextSibling().getLineNo(); + endColNo = temp.getFirstChild().getNextSibling().getColumnNo(); + startLine = temp.getLineNo(); + } + + if (temp.getType() == TokenTypes.PACKAGE_DEF) break; + + while (toVisit == null && temp != null) { + toVisit = temp.getNextSibling(); + temp = temp.getParent(); + } + + temp = toVisit; + } + + packageTextBlock = generateTextBlock(comment, startColNo, endLineNo, endColNo, startLine); + } + + /** + * Generate The TextBlock From Given Comment. + * + * @param comment as DetailAst of The Found JavaDoc Comment + * @return TextBlock of Javadoc comment + */ + public TextBlock generateTextBlock(String comment, int startColNo, int endLineNo, + int endColNo, int startLine) { + final TextBlock textBlock; + + if (comment == null) { + textBlock = null; + } + else { + + final String[] comments = comment.split("\n"); + comments[0] = "/**" + comments[0]; + endColNo++; + + int tempEndLine = startLine + (comments.length - 1); + + if (tempEndLine == endLineNo) { + comments[comments.length-1] += "*/"; + if (comments.length == 1) { + endColNo++; + } + textBlock = new Comment(comments, startColNo, endLineNo, endColNo); + } + else { + String[] modifiedComments = new String[comments.length + 1]; + System.arraycopy(comments, 0, modifiedComments, 0, comments.length); + modifiedComments[comments.length] = "*/"; + textBlock = new Comment(modifiedComments, startColNo, endLineNo, endColNo); + } + } + + return textBlock; + } + + /** + * Find The Javadoc comments Associated With given ast. + * + * @param ast a given node + * @return TextBlock of Javadoc comment + */ + public TextBlock getJavaDoc(DetailAST ast) { + DetailAST temp = ast; + String comment = ""; + int startColNo = 0, endLineNo = 0, endColNo = 0, startLine = 0; + String key = ast.getType() + "-" + ast.getLineNo() + "-" + ast.getColumnNo(); + + while (temp != null) { + DetailAST toVisit = temp.getFirstChild(); + + if (isNewToken(temp)) { + String tempKey = temp.getType() + "-" + temp.getLineNo() + "-" + temp.getColumnNo(); + if (!tempKey.equals(key)) { + toVisit = null; + } + } + + if (toVisit == null) { + String parentKey = temp.getParent().getType() + "-" + + temp.getParent().getLineNo() + "-" + temp.getParent().getColumnNo(); + + if (parentKey.equals(key) && temp.getNextSibling() == null) { + break; + } + } + + if (temp.getType() == TokenTypes.BLOCK_COMMENT_BEGIN) { + int end = temp.getFirstChild().getNextSibling().getLineNo(); + if (JavadocUtil.isJavadocComment(temp) && end < ast.getLineNo()) { + comment = JavadocUtil.getJavadocCommentContent(temp); + startColNo = temp.getColumnNo(); + endLineNo = end; + endColNo = temp.getFirstChild().getNextSibling().getColumnNo(); + startLine = temp.getLineNo(); + } + else if(!JavadocUtil.isJavadocComment(temp) && end < ast.getLineNo()) { + comment = ""; + startColNo = 0; + endLineNo = 0; + endColNo = 0; + startLine = 0; + } + } + + while(toVisit == null && temp != null) { + toVisit = temp.getNextSibling(); + temp = temp.getParent(); + } + + temp = toVisit; - checkComment(ast, textBlock); } + + TextBlock textBlock = null; + + if (!comment.isEmpty()) { + textBlock = generateTextBlock(comment, startColNo, endLineNo, endColNo, startLine); + } + + return textBlock; } /** @@ -420,19 +594,20 @@ public void visitToken(DetailAST ast) { private boolean shouldCheck(final DetailAST ast) { boolean check = false; - if (ast.getType() == TokenTypes.PACKAGE_DEF) { - check = CheckUtil.isPackageInfo(getFilePath()); - } - else if (!ScopeUtil.isInCodeBlock(ast)) { - final Scope customScope = ScopeUtil.getScope(ast); - final Scope surroundingScope = ScopeUtil.getSurroundingScope(ast); + if (ast.getType() != TokenTypes.COMMENT_CONTENT) { + if (ast.getType() == TokenTypes.PACKAGE_DEF) { + check = CheckUtil.isPackageInfo(getFilePath()); + } else if (!ScopeUtil.isInCodeBlock(ast)) { + final Scope customScope = ScopeUtil.getScope(ast); + final Scope surroundingScope = ScopeUtil.getSurroundingScope(ast); - check = customScope.isIn(scope) - && (surroundingScope == null || surroundingScope.isIn(scope)) - && (excludeScope == null + check = customScope.isIn(scope) + && (surroundingScope == null || surroundingScope.isIn(scope)) + && (excludeScope == null || !customScope.isIn(excludeScope) || surroundingScope != null - && !surroundingScope.isIn(excludeScope)); + && !surroundingScope.isIn(excludeScope)); + } } return 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..4b05e57a04a 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 @@ -76,7 +76,7 @@ Control whether to check for incomplete HTML tags. - 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..e85d4764e49 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 @@ -61,6 +61,7 @@ public void testGetAcceptableTokens() { TokenTypes.VARIABLE_DEF, TokenTypes.RECORD_DEF, TokenTypes.COMPACT_CTOR_DEF, + TokenTypes.COMMENT_CONTENT }; assertWithMessage("Default acceptable tokens are invalid") @@ -590,4 +591,70 @@ public void testLowerCasePropertyForTag() throws Exception { verifyWithInlineConfigParser( getPath("InputJavadocStyleCheckOptionLowercaseProperty.java"), expected); } + + @Test + public void packageInfoAnnotation2() throws Exception { + final String[] expected = { + "17:1: " + getCheckMessage(MSG_JAVADOC_MISSING), + }; + + verifyWithInlineConfigParser( + getPath("pkginfo" + File.separator + "annotation2" + File.separator + + "package-info.java"), + expected); + } + + @Test + public void packageInvalidFormat2() throws Exception { + final String[] expected = { + "17:1: " + getCheckMessage(MSG_JAVADOC_MISSING), + }; + + verifyWithInlineConfigParser( + getPath("pkginfo" + File.separator + "invalidformat2" + File.separator + + "package-info.java"), + expected); + } + + @Test + public void packageInvalidFormat3() throws Exception { + final String[] expected = { + "17:1: " + getCheckMessage(MSG_JAVADOC_MISSING), + }; + + verifyWithInlineConfigParser( + getPath("pkginfo" + File.separator + "invalidformat3" + File.separator + + "package-info.java"), + expected); + } + + @Test + public void packageInvalidFormat4() throws Exception { + final String[] expected = { + "17:1: " + getCheckMessage(MSG_JAVADOC_MISSING), + }; + + verifyWithInlineConfigParser( + getPath("pkginfo" + File.separator + "invalidformat4" + File.separator + + "package-info.java"), + expected); + } + + @Test + public void testDefaultSettingFive() throws Exception { + final String[] expected = { + "21: " + getCheckMessage(MSG_NO_PERIOD), + "33: " + getCheckMessage(MSG_NO_PERIOD), + "37: " + getCheckMessage(MSG_NO_PERIOD), + "51: " + getCheckMessage(MSG_NO_PERIOD), + "56: " + getCheckMessage(MSG_NO_PERIOD), + "67: " + getCheckMessage(MSG_NO_PERIOD), + "71: " + getCheckMessage(MSG_NO_PERIOD), + "81: " + getCheckMessage(MSG_NO_PERIOD), + "100:3: " + getCheckMessage(MSG_EXTRA_HTML, ""), + }; + + verifyWithInlineConfigParser( + getPath("InputJavadocStyleDefaultSettingsFive.java"), expected); + } } diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/InputJavadocStyleDefaultSettingsFive.java b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/InputJavadocStyleDefaultSettingsFive.java new file mode 100644 index 00000000000..9c30a8b619b --- /dev/null +++ b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/InputJavadocStyleDefaultSettingsFive.java @@ -0,0 +1,116 @@ +/* +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 + + +*/ + +package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocstyle; + +public class InputJavadocStyleDefaultSettingsFive { + /** Used for component-specific logging: */ + + /** Logger for everything */ // violation + private final int logger = 5; + + /* + * @see TestCase#setUp() + */ + public void demo() {} + + /* + * @see TestCase#setUp() + */ + + /** Monitor guarding all access */ // violation + public void demo2() {} + + /** warn */ + /** valid */ // violation + private int demo = 5; + + /************************* building *********************************/ + + /* + *

  • Only public method used during the tokenization process + *
  • Requires that the input ByteRange sort after the previous, and therefore after all previous + * inputs + *
  • Only looks at bytes of the input array that align with this node's token + */ + public void demoTest() {} +} + +/** // violation +* not ok +*/ +class Demo { } + +/*warn*//** // violation + * + */ +class InnerInputCorrectJavaDocParagraphCheck { + void /** warn */ method20() {} + void method21 /** warn */ () {} + void method22(/** warn */) {} + void method23() /** warn */ {} + void method24() { /** warn */ } + void method25() { /** warn */ int variable; } + + /**Javadoc*/ // violation + enum/**nope*/ AAAAA1/**nope-1*/ {} + enum demo {} + +/** The italic action identifier // violation +*/ + public static final String ITALIC_ACTION = "html-italic-action"; + + /************************************************ + * + * Construction + * + ************************************************/ + + /** // violation + * Constructs XMenuWindow for specified XMenuPeer + * null for XPopupMenuWindow + */ + public void demoMethod() { + + } +} + +/* + * Config: NonTightHtmlTagIntolerantCheck + */ + +/** +* +*

    This class is only meant for testing.

    +*

    In html, closing all tags is not necessary. +*

  • neither is opening every tag

    • +* // violation below +* +* +* @see "https://www.w3.org/TR/html51/syntax.html#optional-start-and-end-tags" +*/ + +class InputAbstract { + public enum MatchCode { + /** + * These codes are used by the ScanQueryMatcher + */ + + /** + * Done with the row, seek there. + */ + SEEK_NEXT_COL + } +} diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/InputJavadocStyleDefaultSettingsFour.java b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/InputJavadocStyleDefaultSettingsFour.java index c1b3183ebac..16b6eb3b08c 100644 --- a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/InputJavadocStyleDefaultSettingsFour.java +++ b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/InputJavadocStyleDefaultSettingsFour.java @@ -111,4 +111,8 @@ public class SampleTest { } */ public void test3() {} // ok + + /* */ + //* + public void demo() {} } diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/InputJavadocStyleDefaultSettingsThree.java b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/InputJavadocStyleDefaultSettingsThree.java index 06ea38b7ad1..8870c11fd29 100644 --- a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/InputJavadocStyleDefaultSettingsThree.java +++ b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/InputJavadocStyleDefaultSettingsThree.java @@ -111,4 +111,8 @@ public void method21() {} * /a> */ void tagClosedInNextLine() {} // ok + + /** demo + * hello. */ + void method24() { } } diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/InputJavadocStyleDefaultSettingsTwo.java b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/InputJavadocStyleDefaultSettingsTwo.java index f6eef21b719..6402fe3ea4e 100644 --- a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/InputJavadocStyleDefaultSettingsTwo.java +++ b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/InputJavadocStyleDefaultSettingsTwo.java @@ -105,4 +105,12 @@ public enum Test // ok */ value2, // ok } + + //* Just For Coverage + private void method20() {} // ok + + /* + * this is good + */ + public void demo() { } } diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/pkginfo/annotation2/package-info.java b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/pkginfo/annotation2/package-info.java new file mode 100644 index 00000000000..11d8dd7d313 --- /dev/null +++ b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/pkginfo/annotation2/package-info.java @@ -0,0 +1,17 @@ +/* +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 + + +*/ + +@Deprecated +package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocstyle.pkginfo.annotation2; //violation diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/pkginfo/invalidformat2/package-info.java b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/pkginfo/invalidformat2/package-info.java new file mode 100644 index 00000000000..14db0f3f8f0 --- /dev/null +++ b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/pkginfo/invalidformat2/package-info.java @@ -0,0 +1,17 @@ +/* +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 + + +*/ + +/* */ +package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocstyle.pkginfo.invalidformat2; // violation diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/pkginfo/invalidformat3/package-info.java b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/pkginfo/invalidformat3/package-info.java new file mode 100644 index 00000000000..3a3f41df86e --- /dev/null +++ b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/pkginfo/invalidformat3/package-info.java @@ -0,0 +1,17 @@ +/* +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 + + +*/ + +// invalid format-3 +package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocstyle.pkginfo.invalidformat3; // violation diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/pkginfo/invalidformat4/package-info.java b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/pkginfo/invalidformat4/package-info.java new file mode 100644 index 00000000000..d2c8fac63e0 --- /dev/null +++ b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/pkginfo/invalidformat4/package-info.java @@ -0,0 +1,17 @@ +/* +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 + + +*/ + +/**/ +package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocstyle.pkginfo.invalidformat4; // violation diff --git a/src/xdocs/config_javadoc.xml b/src/xdocs/config_javadoc.xml index aa980dd7f75..e9e72430e7a 100644 --- a/src/xdocs/config_javadoc.xml +++ b/src/xdocs/config_javadoc.xml @@ -1626,6 +1626,8 @@ public class TestClass { RECORD_DEF , COMPACT_CTOR_DEF + , + COMMENT_CONTENT . @@ -1653,6 +1655,8 @@ public class TestClass { RECORD_DEF , COMPACT_CTOR_DEF + , + COMMENT_CONTENT . 3.2