1 /*
2 JavadocMethod
3 allowedAnnotations = (default)Override
4 validateThrows = (default)false
5 accessModifiers =
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 InputJavadocMethodPublicOnly1One // ignore - need javadoc
16 {
17 private interface InnerInterface // ignore - when not relaxed about Javadoc
18 {
19 String CONST = "InnerInterface"; // ignore - w.n.r.a.j
20 void method(); // ignore - when not relaxed about Javadoc
21
22 class InnerInnerClass // ignore - when not relaxed about Javadoc
23 {
24 private int mData; // ignore - when not relaxed about Javadoc
25
26 private InnerInnerClass()
27 {
28 final Runnable r = new Runnable() {
29 public void run() {};
30 };
31 }
32
33 void method2() // ignore - when not relaxed about Javadoc
34 {
35 final Runnable r = new Runnable() {
36 public void run() {};
37 };
38 }
39 }
40 }
41
42 private class InnerClass // ignore
43 {
44 private int mDiff; // ignore - when not relaxed about Javadoc
45
46 void method() // ignore - when not relaxed about Javadoc
47 {
48 }
49 }
50
51 private int mSize; // ignore - when not relaxed about Javadoc
52 int mLen; // ignore - when not relaxed about Javadoc
53 protected int mDeer; // ignore
54 public int aFreddo; // ignore
55
56 // ignore - need Javadoc
57
58 private InputJavadocMethodPublicOnly1One(int aA)
59 {
60 }
61
62 // ignore - need Javadoc when not relaxed
63 InputJavadocMethodPublicOnly1One(String aA)
64 {
65 }
66
67 // ignore - always need javadoc
68
69 protected InputJavadocMethodPublicOnly1One(Object aA)
70 {
71 }
72
73 // ignore - always need javadoc
74 public InputJavadocMethodPublicOnly1One(Class<Object> aA)
75 {
76 }
77
78 /** Here should be an error, In scope */
79 private void method(int aA)
80 {
81 }
82
83 /** Here should be an error, In scope */
84 void method(Long aA)
85 {
86 }
87
88 /** Here should be an error, In scope */
89 protected void method(Class<Object> aA)
90 {
91 }
92
93 /** Here should be an error, In scope */
94 public void method(StringBuffer aA)
95 {
96 }
97
98
99 /**
100 A param tag should not be required here when relaxed about Javadoc.
101 Writing a little documentation should not be worse than not
102 writing any documentation at all.
103 */
104 private void method(String aA)
105 {
106 }
107
108 /**
109 This inner class has no author tag, which is OK.
110 */
111 public class InnerWithoutAuthor
112 {
113
114 }
115
116 }