View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2026 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.PreferCodeOrSnippetJavadocInlineTagCheck.MSG_KEY_MULTI_LINE;
23  import static com.puppycrawl.tools.checkstyle.checks.javadoc.PreferCodeOrSnippetJavadocInlineTagCheck.MSG_KEY_SINGLE_LINE;
24  
25  import org.junit.jupiter.api.Test;
26  
27  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
28  
29  public class PreferCodeOrSnippetJavadocInlineTagCheckExamplesTest
30      extends AbstractExamplesModuleTestSupport {
31  
32      @Override
33      public String getPackageLocation() {
34          return "com/puppycrawl/tools/checkstyle/checks/javadoc/"
35                  + "prefercodeorsnippetjavadocinlinetag";
36      }
37  
38      @Test
39      public void testCheck() throws Exception {
40          final String[] expected = {
41              "13:6: " + getCheckMessage(MSG_KEY_SINGLE_LINE, "pre"),
42              "29:6: " + getCheckMessage(MSG_KEY_SINGLE_LINE, "code"),
43              "46:6: " + getCheckMessage(MSG_KEY_MULTI_LINE, "pre"),
44          };
45  
46          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
47      }
48  
49  }