View Javadoc
1   /*xml
2   <module name="Checker">
3     <module name="TreeWalker">
4       <module name="JavadocLeadingAsteriskAlign">
5         <property name="tabWidth" value="2"/>
6       </module>
7     </module>
8   </module>
9   */
10  
11  package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocleadingasteriskalign;
12  
13  // xdoc section -- start
14  /**
15   * Example with `tabWidth` property.
16   * This example contains Tabs as well as Spaces.
17   */
18  public class Example3 {
19    /** <- Preceded with Tabs.
20     * <- Preceded with Tabs & Spaces.
21     */ // <- Preceded with Tabs & Spaces.
22    private String name;
23  
24    /** <- Preceded with Spaces.
25     * <- Preceded with Tabs.
26     */ // <- Preceded with Tabs.
27    private void foo() {}
28  
29    /**
30      * // violation
31    */ // violation
32    private Example3() {}
33  
34    private enum tabsExample {
35      /**
36         * Incorrect indentation for leading asterisk. // violation */
37      ONE,
38  
39      /**
40        This javadoc is allowed because there is no leading asterisk.
41       */
42      TWO
43    }
44  }
45  // xdoc section -- end