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 InputJavadocStyleHtml3 {
19 /**
20 * A test class.
21 * @param <T1> this is NOT an unclosed T1 tag
22 * @param <KEY_T> for bug 1649020.
23 * @author <a href="mailto:foo@nomail.com">Foo Bar</a>
24 */
25 public class TestClass<T1, KEY_T>
26 {
27 /**
28 * Retrieves X.
29 * @return a value
30 */
31 public T1 getX()
32 {
33 return null;
34 }
35
36 /**
37 * Retrieves Y.
38 * @param <V> this is not an unclosed V tag
39 * @return a value
40 */
41 public <V> V getY()
42 {
43 return null;
44 }
45
46 /**
47 * Retrieves Z.
48 *
49 * @param <KEY_T1> this is not an unclosed KEY_T tag
50 * @return a value
51 */
52 public <KEY_T1> KEY_T getZ_1649020_1()
53 {
54 return null;
55 }
56
57 /**
58 * Retrieves something.
59 *
60 * @param <KEY_T_$_1_t> strange type
61 * @return a value
62 */
63 public <KEY_T_$_1_t> KEY_T_$_1_t getEh_1649020_2() {
64 return null;
65 }
66
67 /**
68 * Retrieves more something.
69 *
70 * @param <$_12_xY_z> strange type
71 * @return a value
72 */
73 public <$_12_xY_z> $_12_xY_z getUmmm_1649020_3() {
74 return null;
75 }
76 }
77
78 /**
79 * Checks if the specified IClass needs to be
80 * annotated with the @Type annotation.
81 */
82 public void foo_1291847_1() {}
83
84 /**
85 * Returns the string containing the properties of
86 * <code>@Type</code> annotation.
87 */
88 public void foo_1291847_2() {}
89
90 /**
91 * Checks generics javadoc.
92 *
93 * @param strings this is a List<String>
94 * @param test Map<String, List<String>> a map indexed on String of Lists of Strings.
95 */
96 public void method20() {}
97
98 // violation 5 lines below 'Extra HTML tag found: </string>'
99 /**
100 * Checks HTML tags in javadoc.
101 *
102 * HTML no good tag
103 * <string>Tests</string>
104 *
105 */
106 public void method21() {}
107
108 /**
109 * First sentence.
110 * <
111 * /a>
112 */
113 void tagClosedInNextLine() {}
114 }