View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2026 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ///////////////////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle.checks.javadoc;
21  
22  import static com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck.MSG_SUMMARY_FIRST_SENTENCE;
23  import static com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck.MSG_SUMMARY_JAVADOC;
24  import static com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck.MSG_SUMMARY_JAVADOC_MISSING;
25  import static com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck.MSG_SUMMARY_MISSING_PERIOD;
26  
27  import org.junit.jupiter.api.Test;
28  
29  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
30  
31  public class SummaryJavadocCheckExamplesTest extends AbstractExamplesModuleTestSupport {
32      @Override
33      public String getPackageLocation() {
34          return "com/puppycrawl/tools/checkstyle/checks/javadoc/summaryjavadoc";
35      }
36  
37      @Test
38      public void testExample1() throws Exception {
39          final String[] expected = {
40              "18:6: " + getCheckMessage(MSG_SUMMARY_JAVADOC_MISSING),
41              "22:6: " + getCheckMessage(MSG_SUMMARY_JAVADOC_MISSING),
42              "27:6: " + getCheckMessage(MSG_SUMMARY_JAVADOC_MISSING),
43              "42:5: " + getCheckMessage(MSG_SUMMARY_MISSING_PERIOD),
44          };
45  
46          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
47      }
48  
49      @Test
50      public void testExample2() throws Exception {
51          final String[] expected = {
52              "21:6: " + getCheckMessage(MSG_SUMMARY_JAVADOC_MISSING),
53              "25:6: " + getCheckMessage(MSG_SUMMARY_JAVADOC_MISSING),
54              "30:6: " + getCheckMessage(MSG_SUMMARY_JAVADOC_MISSING),
55              "39:6: " + getCheckMessage(MSG_SUMMARY_JAVADOC),
56              "45:5: " + getCheckMessage(MSG_SUMMARY_MISSING_PERIOD),
57          };
58  
59          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
60      }
61  
62      @Test
63      public void testExample3() throws Exception {
64          final String[] expected = {
65              "20:6: " + getCheckMessage(MSG_SUMMARY_JAVADOC_MISSING),
66              "24:6: " + getCheckMessage(MSG_SUMMARY_JAVADOC_MISSING),
67              "29:6: " + getCheckMessage(MSG_SUMMARY_JAVADOC_MISSING),
68              "34:6: " + getCheckMessage(MSG_SUMMARY_MISSING_PERIOD),
69              "38:6: " + getCheckMessage(MSG_SUMMARY_FIRST_SENTENCE),
70              "49:5: " + getCheckMessage(MSG_SUMMARY_MISSING_PERIOD),
71          };
72  
73          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
74      }
75  }