1 /*
2 MissingJavadocMethod
3 minLineCount = (default)-1
4 allowedAnnotations = Override,ThisIsOk, \t\n\t ThisIsOkToo
5 scope = private
6 excludeScope = (default)null
7 allowMissingPropertyJavadoc = (default)false
8 ignoreMethodNamesRegex = (default)null
9 tokens = (default)METHOD_DEF , CTOR_DEF , ANNOTATION_FIELD_DEF , COMPACT_CTOR_DEF
10
11
12 */
13
14 package com.puppycrawl.tools.checkstyle.checks.javadoc.missingjavadocmethod;
15
16 /* Config:
17 * allowedAnnotations = "Override, ThisIsOk, \t\n\t ThisIsOkToo"
18 * scope = "private"
19 */
20 /**
21 * Some javadoc.
22 */
23 public class InputMissingJavadocMethodAllowedAnnotations implements SomeInterface { // ok
24
25 @ThisIsOk
26 public void allowed1() {}
27
28 @ThisIsOkToo
29 public void allowed2() {}
30
31 // violation below 'Missing a Javadoc comment.'
32 @com.puppycrawl.tools.checkstyle.checks.javadoc.missingjavadocmethod.ThisIsOk
33 public void allowed3() {}
34
35 @Override
36 public void method() {}
37 }
38
39 /**
40 * Documented.
41 */
42 interface SomeInterface {
43 /**
44 * Documented.
45 */
46 void method();
47 }
48
49 /**
50 * Some javadoc.
51 */
52 @interface ThisIsOk {}
53
54 /**
55 * Some javadoc.
56 */
57 @interface ThisIsOkToo {}