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.JavadocParagraphCheck.MSG_LINE_BEFORE;
23  import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck.MSG_MISPLACED_TAG;
24  import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck.MSG_PRECEDED_BLOCK_TAG;
25  import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck.MSG_REDUNDANT_PARAGRAPH;
26  import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck.MSG_TAG_AFTER;
27  
28  import org.junit.jupiter.api.Test;
29  
30  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
31  
32  public class JavadocParagraphCheckExamplesTest extends AbstractExamplesModuleTestSupport {
33      @Override
34      protected String getPackageLocation() {
35          return "com/puppycrawl/tools/checkstyle/checks/javadoc/javadocparagraph";
36      }
37  
38      @Test
39      public void testExample1() throws Exception {
40          final String[] expected = {
41              "16:4: " + getCheckMessage(MSG_LINE_BEFORE),
42              "21:4: " + getCheckMessage(MSG_MISPLACED_TAG),
43              "34:6: " + getCheckMessage(MSG_PRECEDED_BLOCK_TAG, "pre"),
44              "52:6: " + getCheckMessage(MSG_REDUNDANT_PARAGRAPH),
45              "62:5: " + getCheckMessage(MSG_TAG_AFTER),
46          };
47  
48          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
49      }
50  
51      @Test
52      public void testExample2() throws Exception {
53          final String[] expected = {
54              "18:4: " + getCheckMessage(MSG_LINE_BEFORE),
55              "20:4: " + getCheckMessage(MSG_MISPLACED_TAG),
56              "23:4: " + getCheckMessage(MSG_MISPLACED_TAG),
57              "36:6: " + getCheckMessage(MSG_PRECEDED_BLOCK_TAG, "pre"),
58              "36:6: " + getCheckMessage(MSG_MISPLACED_TAG),
59              "55:6: " + getCheckMessage(MSG_MISPLACED_TAG),
60              "55:6: " + getCheckMessage(MSG_REDUNDANT_PARAGRAPH),
61              "64:5: " + getCheckMessage(MSG_TAG_AFTER),
62          };
63  
64          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
65      }
66  
67  }