View Javadoc
1   /*
2   JavadocMethod
3   allowedAnnotations = (default)Override
4   validateThrows = (default)false
5   accessModifiers = private, package, public
6   allowMissingParamTags = (default)false
7   allowMissingReturnTag = (default)false
8   tokens = (default)METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF
9   
10  
11  */
12  
13  package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocmethod;
14  
15  public class InputJavadocMethodNoJavadocOnlyPrivateScope //comment test
16  {
17      public int i1;
18      protected int i2;
19      int i3;
20      private int i4;
21  
22      public void foo1() {}
23      protected void foo2() {}
24      void foo3() {}
25      private void foo4() {}
26  
27      /** @return wrong, in scope */ // violation 'Unused Javadoc tag.'
28      public void foo5() {}
29      /** @return correct, out of scope */ // ok
30      protected void foo6() {}
31      /** @return wrong, in scope */ // violation 'Unused Javadoc tag.'
32      void foo7() {}
33      /** @return wrong, in scope */ // violation 'Unused Javadoc tag.'
34      private void foo8() {}
35  
36      protected class ProtectedInner { // ignored
37          public int i1;
38          protected int i2;
39          int i3;
40          private int i4;
41  
42          public void foo1() {}
43          protected void foo2() {}
44          void foo3() {}
45          private void foo4() {}
46      }
47  
48      class PackageInner { // ignored
49          public int i1;
50          protected int i2;
51          int i3;
52          private int i4;
53  
54          public void foo1() {}
55          protected void foo2() {}
56          void foo3() {}
57          private void foo4() {}
58      }
59  
60      private class PrivateInner { // ignored
61          public int i1;
62          protected int i2;
63          int i3;
64          private int i4;
65  
66          public void foo1() {}
67          protected void foo2() {}
68          void foo3() {}
69          private void foo4() {}
70      }
71  }
72  
73  class InputJavadocMethodNoJavadocOnlyPrivateScopePackage { // ignored
74      public int i1;
75      protected int i2;
76      int i3;
77      private int i4;
78  
79      public void foo1() {}
80      protected void foo2() {}
81      void foo3() {}
82      private void foo4() {}
83  
84      public class PublicInner { // ignored
85          public int i1;
86          protected int i2;
87          int i3;
88          private int i4;
89  
90          public void foo1() {}
91          protected void foo2() {}
92          void foo3() {}
93          private void foo4() {}
94      }
95  
96      protected class ProtectedInner { // ignored
97          public int i1;
98          protected int i2;
99          int i3;
100         private int i4;
101 
102         public void foo1() {}
103         protected void foo2() {}
104         void foo3() {}
105         private void foo4() {}
106     }
107 
108     class PackageInner { // ignored
109         public int i1;
110         protected int i2;
111         int i3;
112         private int i4;
113 
114         public void foo1() {}
115         protected void foo2() {}
116         void foo3() {}
117         private void foo4() {}
118     }
119 
120     private class PrivateInner { // ignored
121         public int i1;
122         protected int i2;
123         int i3;
124         private int i4;
125 
126         public void foo1() {}
127         protected void foo2() {}
128         void foo3() {}
129         private void foo4() {}
130     }
131 
132     class IgnoredName { // ignored
133         // ignore by name
134         private int logger;
135         // no warning, 'serialVersionUID' fields do not require Javadoc
136         private static final long serialVersionUID = 0;
137     }
138 
139     /**/
140     void methodWithTwoStarComment() {}  // ignored
141 }