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 = (default)false
8   checkHtml = (default)true
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 InputJavadocStyleHtml2 {
19      /**
20       * Tags for two lines.
21       * <a href="some_link"
22       * >Link Text</a>
23       */
24      private void method12() {}
25  
26      /**
27       * First sentence.
28       * <pre>
29       * +--LITERAL_DO (do)
30       *     |
31       *     +--SLIST ({)
32       *         |
33       *         +--EXPR
34       *             |
35       *             +--ASSIGN (=)
36       *                 |
37       *                 +--IDENT (x)
38       *                 +--METHOD_CALL (()
39       *                     |
40       *                     +--DOT (.)
41       *                         |
42       *                         +--IDENT (rand)
43       *                         +--IDENT (nextInt)
44       *                     +--ELIST
45       *                         |
46       *                         +--EXPR
47       *                             |
48       *                             +--NUM_INT (10)
49       *                     +--RPAREN ())
50       *         +--SEMI (;)
51       *         +--RCURLY (})
52       *     +--LPAREN (()
53       *     +--EXPR
54       *         |
55       *         +--LT (<)
56       *             |
57       *             +--IDENT (x)
58       *             +--NUM_INT (5)
59       *     +--RPAREN ())
60       *     +--SEMI (;)
61       * </pre>
62       */
63      private void method13() {}
64  
65      // violation 3 lines below 'Unclosed HTML tag found: <blockquote>'
66      /**
67       * Some problematic javadoc. Sample usage:
68       * <blockquote>
69       */
70  
71      private void method14() {}
72  
73      /**
74       * Empty line between javadoc and method declaration cause wrong
75       * line number for reporting error (bug 841942)
76       */
77  
78      private void method15() {}
79  
80      /** Description of field: {@value}. */
81      public static final int dummy = 4911;
82  
83      /**
84       */
85      public void method16() {}
86  
87      /**
88       * @param a A parameter
89       */
90      protected void method17(String a) {}
91  
92      /**
93       * @exception RuntimeException should be thrown
94       */
95      void method18(String a) {}
96  
97      /**
98       */
99      private static int ASDF = 0;
100 
101     /** @see Object */
102     public void method19() {}
103 
104     public enum Test
105     {
106         /**
107          * Value 1 without a period
108          */
109         value1,
110 
111         /**
112          * Value 2 with a period.
113          */
114         value2,
115     }
116 }