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          };
42          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
43      }
44  
45      @Test
46      public void testExample2() throws Exception {
47          final String[] expected = {
48              "21:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
49          };
50  
51          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
52      }
53  
54      @Test
55      public void testExample3() throws Exception {
56          final String[] expected = {
57              "14:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
58              "22:15: " + getCheckMessage(MSG_JAVADOC_MISSING),
59          };
60  
61          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
62      }
63  
64      @Test
65      public void testExample4() throws Exception {
66          final String[] expected = {
67              "14:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
68              "20:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
69              "21:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
70              "22:15: " + getCheckMessage(MSG_JAVADOC_MISSING),
71          };
72  
73          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
74      }
75  }