View Javadoc
1   /*
2   JavadocStyle
3   scope = (default)private
4   excludeScope = protected
5   checkFirstSentence = (default)true
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 InputJavadocStyleExcludeScope3
19  {
20      /**
21      * A test class.
22      * @param <T1> this is NOT an unclosed T1 tag
23      * @param <KEY_T> for bug 1649020.
24      * @author <a href="mailto:foo@nomail.com">Foo Bar</a>
25      */
26      public class TestClass<T1, KEY_T>
27      {
28          /**
29          * Retrieves X.
30          * @return a value
31          */
32          public T1 getX()
33          {
34              return null;
35          }
36  
37          /**
38          * Retrieves Y.
39          * @param <V> this is not an unclosed V tag
40          * @return a value
41          */
42          public <V> V getY()
43          {
44              return null;
45          }
46  
47          /**
48           * Retrieves Z.
49           *
50           * @param <KEY_T1> this is not an unclosed KEY_T tag
51           * @return a value
52           */
53          public <KEY_T1> KEY_T getZ_1649020_1()
54          {
55              return null;
56          }
57  
58          /**
59           * Retrieves something.
60           *
61           * @param <KEY_T_$_1_t> strange type
62           * @return a value
63           */
64          public <KEY_T_$_1_t> KEY_T_$_1_t getEh_1649020_2() {
65              return null;
66          }
67  
68          /**
69           * Retrieves more something.
70           *
71           * @param <$_12_xY_z> strange type
72           * @return a value
73           */
74          public <$_12_xY_z> $_12_xY_z getUmmm_1649020_3() {
75              return null;
76          }
77      }
78  
79      /**
80       * Checks if the specified IClass needs to be
81       * annotated with the @Type annotation.
82       */
83      public void foo_1291847_1() {}
84  
85      /**
86       * Returns the string containing the properties of
87       * <code>@Type</code> annotation.
88       */
89      public void foo_1291847_2() {}
90  
91      /**
92       * Checks generics javadoc.
93       *
94       * @param strings this is a List<String>
95       * @param test Map<String, List<String>> a map indexed on String of Lists of Strings.
96       */
97      public void method20() {}
98  
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 }