View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // Test case file for checkstyle.
3   // Created: 2014
4   ////////////////////////////////////////////////////////////////////////////////
5   
6   package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocstyle;
7   
8   /**
9    * Test input for the JavadocStyleCheck.  This check is used to perform 
10   * some additional Javadoc validations.  
11   * 
12   * @author Tobias Geyer
13   * @version 1.0
14   */
15  public class InputJavadocStyleHtmlComment
16  {
17      /**
18       * sometimes a tag starts
19       * <pre>
20       * somewhere and has a comment in the middle
21       * <!-- ignore this -->
22       * and ends afterwards
23       * </pre>
24       */
25      private void method1()
26      { // JavadocStyle should not report any error for this method
27      }
28  
29      /**
30       * sometimes a tag starts
31       * <pre>
32       * somewhere and has a multiline comment in the middle
33       * <!-- ignore this 
34       * spanning
35       * multiple lines -->
36       * and ends afterwards
37       * </pre>
38       */
39      private void method2()
40      { // JavadocStyle should not report any error for this method
41      }
42  
43      /**
44       * sometimes a tag starts
45       * <pre>
46       * somewhere and has a multiline comment in the middle
47       * <!-- ignore this 
48       * spanning
49       * multiple lines --></pre>
50       * and ends on the same line
51       */
52      private void method3()
53      { // JavadocStyle should not report any error for this method
54      }
55      
56      /**
57       * sometimes a tag starts
58       * <pre>
59       * somewhere and has a comment in the middle
60       * <!-- ignore this --> with text following
61       * and ends afterwards
62       * </pre>
63       */
64      private void method4()
65      { // JavadocStyle should not report any error for this method
66      }
67      
68      /**
69       * sometimes a tag starts
70       * <pre><!-- ignore this --></pre>
71       * and ends with a comment in the middle
72       */
73      private void method5()
74      { // JavadocStyle should not report any error for this method
75      }
76  
77      /**
78       * Parameterized interface.
79       * @param <I>
80       */
81      interface Interface<I> {}
82  }