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              "28:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
40          };
41  
42          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
43      }
44  
45      @Test
46      public void testExample2() throws Exception {
47          final String[] expected = {
48              "14:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
49              "15:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
50              "26:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
51              "27:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
52              "28:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
53              "30:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
54          };
55  
56          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
57      }
58  
59      @Test
60      public void testExample3() throws Exception {
61          final String[] expected = {
62              "15:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
63              "16:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
64              "27:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
65              "29:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
66              "31:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
67          };
68  
69          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
70      }
71  
72      @Test
73      public void testExample4() throws Exception {
74          final String[] expected = {
75              "14:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
76          };
77  
78          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
79      }
80  
81      @Test
82      public void testExample5() throws Exception {
83          final String[] expected = {
84              "14:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
85              "15:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
86              "30:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
87          };
88  
89          verifyWithInlineConfigParser(getPath("Example5.java"), expected);
90      }
91  
92      @Test
93      public void testExample6() throws Exception {
94          final String[] expected = {
95              "14:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
96              "15:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
97              "30:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
98          };
99  
100         verifyWithInlineConfigParser(getPath("Example6.java"), expected);
101     }
102 
103     @Test
104     public void testExample7() throws Exception {
105         final String[] expected = {
106             "30:3: " + getCheckMessage(MSG_JAVADOC_MISSING),
107         };
108 
109         verifyWithInlineConfigParser(getPath("Example7.java"), expected);
110     }
111 }