View Javadoc
1   /*xml
2   <module name="Checker">
3     <module name="TreeWalker">
4       <module name="JavadocContentLocation">
5         <property name="location" value="first_line"/>
6       </module>
7     </module>
8   </module>
9   */
10  
11  package com.puppycrawl.tools.checkstyle.checks.javadoc.javadoccontentlocation;
12  
13  // xdoc section -- start
14  class Example2 {
15  
16    /** This comment is OK because it starts on the first line.
17     * There may be additional text.
18     */
19    private int field1;
20  
21    // violation below, 'Javadoc content should start from the same line.'
22    /**
23     * This comment causes a violation because it starts on the second line.
24     */
25    private int field2;
26  
27    /** This single-line comment also is OK. */
28    private int field3;
29  
30  }
31  // xdoc section -- end