View Javadoc
1   /*
2   JavadocStyle
3   scope = (default)private
4   excludeScope = (default)null
5   checkFirstSentence = false
6   endOfSentenceFormat = (default)([.?!][ \t\n\r\f<])|([.?!]$)
7   checkEmptyJavadoc = true
8   checkHtml = false
9   tokens = (default)ANNOTATION_DEF, ANNOTATION_FIELD_DEF, CLASS_DEF, CTOR_DEF, \
10           ENUM_CONSTANT_DEF, ENUM_DEF, INTERFACE_DEF, METHOD_DEF, PACKAGE_DEF, \
11           VARIABLE_DEF, RECORD_DEF, COMPACT_CTOR_DEF
12  
13  
14  */
15  
16  package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocstyle;
17  
18  public class InputJavadocStyleEmptyJavadoc4 {
19          /**
20       * Link to some page in two lines.
21       * <a
22       * href="someLink"/>
23       */
24      void tagInTwoLines() {}
25  
26      /**
27       * This Javadoc contains unclosed tag.
28       * <code>unclosed 'code' tag<code>
29       */
30      private void unclosedTag() {}
31  
32      void javadocLikeCommentInMethod() {
33          /**
34           * It pretends to be Javadoc without dot, but it's just comment in method
35           */
36          final int i = 0;
37      }
38  
39      /**
40       * {@inheritDoc}
41       */
42      private void inheritDoc() {}
43  
44      /**
45       * <p><b>Note:<b> it's unterminated tag.</p>
46       */
47      private void unterminatedTag() {}
48  
49      /**
50       * Javadoc without dot
51       */
52      public interface TestInterface {
53          /**
54           * Javadoc without dot
55           */
56          void method();
57      }
58  
59      static class TestStaticClass {
60          /**
61           * Javadoc without dot
62           */
63          public int field;
64      }
65  
66      /**
67       * .
68       * @throws Exception if an error occurs
69       */
70      void foo() throws Exception {}
71  
72      /**
73       * text /
74       * @throws Exception if an error occurs
75       */
76      void bar() throws Exception {}
77  
78      /**
79       * {@inheritDoc}
80       * <p>
81       * @throws IllegalArgumentException with errMsg as its message
82       */
83      void inheritDocWithThrows() {}
84  
85      /**
86       * /
87       *
88       **
89       * @param s
90       * @return Return
91       */
92      public int test(String s) { return 0; }
93  
94      /** Set of all class field names.*/
95      public String field;
96  
97      /**
98       * <p>Test.</p>
99       * <pre class="body">
100          for (
101           ; i &lt; j; i++, j--) {}
102        </pre>
103      */
104     public void test2() {}
105 
106     /**
107      * <p>Test.</p>
108      * <pre><code>&#064;ExtendWith(SpotBugsExtension.class)
109 public class SampleTest {
110 }</code></pre>
111      */
112     public void test3() {}
113 }