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 MissingJavadocMethodCheckExamplesTest extends AbstractExamplesModuleTestSupport {
29      @Override
30      protected String getPackageLocation() {
31          return "com/puppycrawl/tools/checkstyle/checks/javadoc/missingjavadocmethod";
32      }
33  
34      @Test
35      public void testExample1() throws Exception {
36          final String[] expected = {
37              "12:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
38              "13:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
39          };
40  
41          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
42      }
43  
44      @Test
45      public void testExample2() throws Exception {
46          final String[] expected = {
47              "14:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
48              "15:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
49              "26:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
50              "27:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
51              "28:3: " + 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              "15:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
61              "16:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
62              "27:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
63              "29:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
64          };
65  
66          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
67      }
68  
69      @Test
70      public void testExample4() throws Exception {
71          final String[] expected = {
72              "14:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
73          };
74  
75          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
76      }
77  
78      @Test
79      public void testExample5() throws Exception {
80          final String[] expected = {
81              "14:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
82              "15:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
83          };
84  
85          verifyWithInlineConfigParser(getPath("Example5.java"), expected);
86      }
87  
88      @Test
89      public void testExample6() throws Exception {
90          final String[] expected = {
91              "14:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
92              "15:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
93          };
94  
95          verifyWithInlineConfigParser(getPath("Example6.java"), expected);
96      }
97  }