View Javadoc
1   package com.google.checkstyle.test.chapter7javadoc.rule712paragraphs;
2   
3   // violation 3 lines below '<p> tag should be preceded with an empty line.'
4   /**
5    * Some Javadoc.
6    * <p>
7    * /^ WARN/ Some Javadoc.<p>
8    */
9   // violation 2 lines above '<p> tag should be preceded with an empty line.'
10  
11  class InputIncorrectJavadocParagraph {
12  
13    // violation 2 lines below '<p> tag should be preceded with an empty line.'
14    /**
15     * Some Javadoc.<p>
16     *
17     * <p>  Some Javadoc.
18     *
19     * @since 8.0
20     */
21    // violation 4 lines above '<p> tag should be placed immediately before the first word'
22    public static final byte NUL = 0;
23  
24    // violation 2 lines below '<p> tag should be preceded with an empty line.'
25    /**
26     * Some <p>Javadoc.
27     *
28     * <p>Some Javadoc.
29     *
30     * @see <a
31     *     href="http://www.gwtproject.org/doc/latest/DevGuideOrganizingProjects.html#DevGuideModules">
32     *     Documentation about GWT emulated source</a>
33     */
34    boolean emulated() {
35      return false;
36    }
37  
38    // violation 2 lines below 'Redundant <p> tag.'
39    // violation 2 lines below '<p> tag should be preceded with an empty line.'
40    /**<p>Some Javadoc.
41     * <p>
42     * <p><p>
43     * <p>/^WARN/ Some Javadoc.<p>
44     */
45    // violation 3 lines above '<p> tag should be preceded with an empty line.'
46    // violation 3 lines above '<p> tag should be preceded with an empty line.'
47    class InnerInputCorrectJavaDocParagraphCheck {
48  
49      // violation 2 lines below '<p> tag should be preceded with an empty line.'
50      /**
51       * Some Javadoc.<p>
52       *
53       * @since 8.0
54       */
55      public static final byte NUL = 0;
56  
57      // violation below 'Redundant <p> tag.'
58      /**<p>
59       * /^WARN/ Some Javadoc.
60       *
61       * <P>
62       * /^WARN/
63       * <p>
64       *  /^WARN/ Some Javadoc.<p>
65       * @see <a
66       *     href="http://www.gwtproject.org/doc/latest/DevGuideOrganizingProjects.html#DevGuideModules">
67       *     Documentation about GWT emulated source</a>
68       */
69      // violation 6 lines above '<p> tag should be preceded with an empty line.'
70      // violation 6 lines above '<p> tag should be preceded with an empty line.'
71      // violation 6 lines above 'Javadoc tag '@see' should be preceded with an empty line.'
72      boolean emulated() {
73        return false;
74      }
75    }
76  
77    InnerInputCorrectJavaDocParagraphCheck anon =
78        new InnerInputCorrectJavaDocParagraphCheck() {
79  
80          // violation 2 lines below 'Redundant <p> tag.'
81          /**
82           * <p>Some Javadoc.
83           *
84           * <p>Some Javadoc.
85           *
86           * @since 8.0
87           */
88          public static final byte NUL = 0;
89  
90          // violation 3 lines below '<p> tag should be preceded with an empty line.'
91          // violation 4 lines below '<p> tag should be placed immediately before the first word'
92          /**
93           * /WARN/  Some Javadoc.<p>
94           *
95           *  <p>  Some Javadoc.
96           *
97           * @see <a href="http://www.gwtproject.org/doc/latest/DevGuideOrganizingProjects.html#DevGuideModules">
98           *     Documentation about <p> GWT emulated source</a>
99           */
100         // 2 violations 2 lines above:
101         //  '<p> tag should be placed immediately before the first word'
102         //  '<p> tag should be preceded with an empty line.'
103         boolean emulated() {
104           return false;
105         }
106       };
107 
108   /* 4 lines below, no violation until #15685 */
109   /**
110    * Some summary.
111    *
112    * <p><h1>Testing...</h1></p>
113    */
114   class InnerPrecedingPtag {
115     /* 5 lines below, no violation until #15685 */
116     /**
117      * Some summary.
118      *
119      *<p>
120      *  <ul>
121      *    <p>
122      *      <li>1</li> // should NOT give violation as there is not empty line before
123      *    </p>
124      *  </ul>
125      *</p>
126      */
127     public void foo() {}
128 
129     /* 5 lines below, no violation until #15685 */
130     /**
131      *  Some summary.
132      *
133      * <p>
134      *  <table>
135      *  </table>
136      * </p>
137      */
138     public void fooo() {}
139 
140     /* 5 lines below, no violation until #15685 */
141     /**
142      * Some summary.
143      *
144      * <p>
145      *   <pre>testing...</pre>
146      *   <pre>testing...</pre>
147      * </p>
148      */
149     public void foooo() {}
150   }
151 }