View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2025 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.JavadocStyleCheck.MSG_INCOMPLETE_TAG;
23  import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.MSG_NO_PERIOD;
24  
25  import org.junit.jupiter.api.Test;
26  
27  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
28  
29  public class JavadocStyleCheckExamplesTest extends AbstractExamplesModuleTestSupport {
30      @Override
31      protected String getPackageLocation() {
32          return "com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle";
33      }
34  
35      @Test
36      public void testExample1() throws Exception {
37          final String[] expected = {
38              "11: " + getCheckMessage(MSG_NO_PERIOD),
39              "30: " + getCheckMessage(MSG_NO_PERIOD),
40              "36: " + getCheckMessage(MSG_NO_PERIOD),
41              "42: " + getCheckMessage(MSG_NO_PERIOD),
42              "49: " + getCheckMessage(MSG_NO_PERIOD),
43              "51: " + getCheckMessage(MSG_INCOMPLETE_TAG, "   * <p"),
44          };
45  
46          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
47      }
48  
49      @Test
50      public void testExample2() throws Exception {
51          final String[] expected = {
52              "13: " + getCheckMessage(MSG_NO_PERIOD),
53              "38: " + getCheckMessage(MSG_NO_PERIOD),
54          };
55  
56          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
57      }
58  
59      @Test
60      public void testExample3() throws Exception {
61          final String[] expected = {
62              "33: " + getCheckMessage(MSG_NO_PERIOD),
63              "45: " + getCheckMessage(MSG_NO_PERIOD),
64              "52: " + getCheckMessage(MSG_NO_PERIOD),
65              "54: " + getCheckMessage(MSG_INCOMPLETE_TAG, "   * <p"),
66          };
67  
68          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
69      }
70  
71      @Test
72      public void testExample4() throws Exception {
73          final String[] expected = {
74              "53: " + getCheckMessage(MSG_INCOMPLETE_TAG, "   * <p"),
75          };
76  
77          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
78      }
79  
80      @Test
81      public void testExample5() throws Exception {
82          final String[] expected = {
83              "13: " + getCheckMessage(MSG_NO_PERIOD),
84              "32: " + getCheckMessage(MSG_NO_PERIOD),
85              "38: " + getCheckMessage(MSG_NO_PERIOD),
86              "44: " + getCheckMessage(MSG_NO_PERIOD),
87              "51: " + getCheckMessage(MSG_NO_PERIOD),
88          };
89  
90          verifyWithInlineConfigParser(getPath("Example5.java"), expected);
91      }
92  
93      @Test
94      public void testExample6() throws Exception {
95          final String[] expected = {
96              "13: " + getCheckMessage(MSG_NO_PERIOD),
97          };
98  
99          verifyWithInlineConfigParser(getPath("Example6.java"), expected);
100     }
101 }