View Javadoc
1   /*
2   JavadocParagraph
3   violateExecutionOnNonTightHtml = (default)false
4   allowNewlineParagraph = (default)true
5   
6   
7   */
8   
9   package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocparagraph;
10  
11  // violation 3 lines below 'tag should be preceded with an empty line.'
12  /**
13   * Some Javadoc.
14   * <p>
15   * /^ WARN/   Some Javadoc.<p>
16   *
17   */
18  // violation 3 lines above 'tag should be preceded with an empty line.'
19  class InputJavadocParagraphIncorrect {
20  
21      // violation 2 lines below 'tag should be preceded with an empty line.'
22      /**
23       * Some Javadoc.<P>
24       *
25       * <p>  Some Javadoc. // violation 'tag should be placed immediately before the first word'
26       *
27       * @since 8.0
28       */
29      public static final byte NUL = 0;
30  
31      // violation 2 lines below '<p> tag should be preceded with an empty line.'
32      /**
33       * Some <p>Javadoc.
34       *
35       * <p>    Some Javadoc. // violation 'tag should be placed immediately before the first word'
36       *
37       * @see <a href="http://www.gwtproject.org/doc/latest/DevGuideOrganizingProjects.html#DevGuideModules">
38       *     Documentation about GWT emulated source</a>
39       */
40      boolean emulated() {return false;}
41  
42      // 2 violations 4 lines below:
43      //  'tag should be preceded with an empty line.'
44      //  'Redundant <p> tag.'
45      // violation 2 lines below 'tag should be preceded with an empty line.'
46      /**<p>Some Javadoc.<p>
47       * <p>
48       * <p><p>
49       * <p>/^WARN/   Some Javadoc.<p>*/
50      // violation 2 lines above 'tag should be preceded with an empty line.'
51      // 2 violations 2 lines above:
52      //  '<p> tag should be placed immediately before the first word'
53      //  'tag should be preceded with an empty line.'
54       class InnerInputJavadocParagraphIncorrect {
55  
56          // violation 2 lines below 'tag should be preceded with an empty line.'
57          /**
58           * Some Javadoc./WARN/<p>
59           *
60           * @since 8.0
61           */
62          public static final byte NUL = 0;
63  
64          // violation below 'Redundant \<p\> tag.'
65          /**<p>
66           * /^WARN/ Some Javadoc.
67           *
68           * <P> // violation 'tag should be placed immediately before the first word'
69           * /^WARN/
70           * <p>
71           *  /^WARN/ Some Javadoc.<p>
72           * @see <a href="http://www.gwtproject.org/doc/latest/DevGuideOrganizingProjects.html#DevGuideModules">
73           *     Documentation about GWT emulated source</a>
74           */
75          // violation 5 lines above 'tag should be preceded with an empty line.'
76          // violation 5 lines above 'tag should be preceded with an empty line.'
77          boolean emulated() {return false;}
78      }
79  
80      InnerInputJavadocParagraphIncorrect anon = new InnerInputJavadocParagraphIncorrect() {
81  
82          // violation 2 lines below 'Redundant <p> tag.'
83              /**
84           * <p>Some Javadoc.
85           *
86           * Some Javadoc.
87           *
88           * @since 8.0
89           */
90          // violation 5 lines above 'Empty line should be followed by <p> tag on the next line.'
91          public static final byte NUL = 0;
92  
93          // violation 2 lines below 'tag should be preceded with an empty line.'
94          /**
95           * /WARN/  Some Javadoc.<p>
96           *
97           *  <p>  Some Javadoc. // violation 'tag should be placed immediately before the first word'
98           *
99           * @see <a href="http://www.gwtproject.org/doc/latest/DevGuideOrganizingProjects.html#DevGuideModules">
100          *     Documentation about <p> GWT emulated source</a>
101          */
102         // 2 violations 2 lines above:
103         //  'tag should be placed immediately before the first word'
104         //  'tag should be preceded with an empty line.'
105         boolean emulated() {return false;}
106 
107         // violation 3 lines below 'Empty line should be followed by <p> tag on the next line.'
108         /**
109          * Double newline.
110          *
111          *
112          * Some Javadoc. //DOUBLE WARN AT TWO PREVIOUS LINES
113          */
114         // violation 3 lines above 'Empty line should be followed by <p> tag on the next line.'
115          void doubleNewline() {}
116     };
117 }