View Javadoc
1   /*xml
2   <module name="Checker">
3     <module name="TreeWalker">
4       <module name="JavadocLeadingAsteriskAlign" />
5     </module>
6   </module>
7   */
8   
9   package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocleadingasteriskalign;
10  
11  // xdoc section -- start
12  /** Title
13   * Javadoc for class
14   */
15  public class Example1 {
16  
17    /** javadoc for instance variable. */
18    private int ball;
19  
20    /**
21     * Javadoc for instance variable
22     */
23    private int age;
24  
25    /**
26     Javadoc for method. */
27    private void foo() {}
28  
29    /**
30      Javadoc for Constructor.
31      This javadoc is allowed because there is no leading asterisk.
32     */
33    public Example1() {}
34  
35    /**
36     * Javadoc for enum.
37     */
38    private enum correctJavadocEnum {
39      /**
40       * Correct Indentation for leading asterisk */
41      ONE,
42  
43      /**
44       Allowed because there are non-whitespace characters before the ending block. */
45      TWO
46    }
47  }
48  // xdoc section -- end