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.JavadocVariableCheck.MSG_JAVADOC_MISSING;
23  
24  import org.junit.jupiter.api.Test;
25  
26  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
27  
28  public class JavadocVariableCheckExamplesTest extends AbstractExamplesModuleTestSupport {
29      @Override
30      protected String getPackageLocation() {
31          return "com/puppycrawl/tools/checkstyle/checks/javadoc/javadocvariable";
32      }
33  
34      @Test
35      public void testExample1() throws Exception {
36          final String[] expected = {
37              "12:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
38              "18:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
39              "19:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
40              "20:15: " + getCheckMessage(MSG_JAVADOC_MISSING),
41              "23:5: " + getCheckMessage(MSG_JAVADOC_MISSING),
42              "27:5: " + getCheckMessage(MSG_JAVADOC_MISSING),
43          };
44          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
45      }
46  
47      @Test
48      public void testExample2() throws Exception {
49          final String[] expected = {
50              "21:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
51              "25:5: " + getCheckMessage(MSG_JAVADOC_MISSING),
52          };
53  
54          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
55      }
56  
57      @Test
58      public void testExample3() throws Exception {
59          final String[] expected = {
60              "14:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
61              "22:15: " + getCheckMessage(MSG_JAVADOC_MISSING),
62              "29:5: " + getCheckMessage(MSG_JAVADOC_MISSING),
63          };
64  
65          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
66      }
67  
68      @Test
69      public void testExample4() throws Exception {
70          final String[] expected = {
71              "14:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
72              "20:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
73              "21:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
74              "22:15: " + getCheckMessage(MSG_JAVADOC_MISSING),
75              "25:5: " + getCheckMessage(MSG_JAVADOC_MISSING),
76              "29:5: " + getCheckMessage(MSG_JAVADOC_MISSING),
77          };
78  
79          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
80      }
81  
82      @Test
83      public void testExample5() throws Exception {
84          final String[] expected = {
85              "12:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
86              "13:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
87              "14:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
88              "15:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
89              "18:5: " + getCheckMessage(MSG_JAVADOC_MISSING),
90              "22:5: " + getCheckMessage(MSG_JAVADOC_MISSING),
91          };
92  
93          verifyWithInlineConfigParser(getPath("Example5.java"), expected);
94      }
95  }