View Javadoc
1   /*xml
2   <module name="Checker">
3     <module name="TreeWalker">
4       <module name="JavadocMissingLeadingAsterisk"/>
5     </module>
6   </module>
7   */
8   package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocmissingleadingasterisk;
9   
10  // xdoc section -- start
11  /**
12   * Valid Java-style comment.
13   *
14   * <pre>
15   *   int value = 0;
16   * </pre>
17   */
18  class JavaStyle {}
19  
20  /** Valid Scala-style comment.
21    * Some description here.
22    **/
23  class ScalaStyle {}
24  
25  /** **
26    * Asterisks on first and last lines are optional.
27    * */
28  class Asterisks {}
29  
30  /** No asterisks are required for single-line comments. */
31  class SingleLine {}
32  
33  /**
34  
35   */ // violation above, 'Javadoc line should start with leading asterisk'
36  class BlankLine {}
37  
38  /** Wrapped
39      single-line comment */
40  // violation above, 'Javadoc line should start with leading asterisk'
41  class Wrapped {}
42  
43  /**
44    * <pre>
45      int value; // violation, 'Javadoc line should start with leading asterisk'
46    * </pre>
47    */
48  class Example1 {}
49  // xdoc section -- end