View Javadoc
1   /*
2   MissingJavadocMethod
3   minLineCount = (default)-1
4   allowedAnnotations = (default)Override
5   scope = (default)public
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  import java.lang.annotation.ElementType;
17  import java.lang.annotation.Target;
18  
19  /* Config = default */
20  public class InputMissingJavadocMethodPublicMethods {
21  
22      public void annotation(final char @SomeAnnotation [] arg) {} // violation
23  
24      public @SomeAnnotation String @SomeAnnotation [] annotationInSignature() { // violation
25          return new String[]{};
26      }
27  
28      public static <T> T[] typeInSignature(T[] array) { // violation
29          return null;
30      }
31      public static <T> T[][] typeInSignature2(T[][] array) { // violation
32          return null;
33      }
34  
35      public static void main(String[] args) throws Exception {} // violation
36  
37      /**
38       * Some javadoc
39       */
40      public void annotation1(final char @SomeAnnotation [] arg) {}
41  
42      /**
43       * Some javadoc
44       */
45      public @SomeAnnotation String @SomeAnnotation [] annotationInSignature1() {
46          return new String[]{};
47      }
48  
49      /**
50       * Some javadoc
51       */
52      public static <T> T[] typeInSignature3(T[] array) {
53          return null;
54      }
55  
56      /**
57       * Some javadoc
58       */
59      public static <T> T[][] typeInSignature4(T[][] array) {
60          return null;
61      }
62  
63      /**
64       * Some javadoc
65       */
66      public static void mainWithArgs(String[] args) throws Exception {}
67  
68      @Target(ElementType.TYPE_USE)
69      @interface SomeAnnotation {
70      }
71  }