aboutsummaryrefslogtreecommitdiff
path: root/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/InputJavadocStyleHtmlComment.java
blob: 581e1ddd1b16148c55f9919f2542de3b6275f724 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
////////////////////////////////////////////////////////////////////////////////
// Test case file for checkstyle.
// Created: 2014
////////////////////////////////////////////////////////////////////////////////

package com.puppycrawl.tools.checkstyle.checks.javadoc;

/**
 * Test input for the JavadocStyleCheck.  This check is used to perform 
 * some additional Javadoc validations.  
 * 
 * @author Tobias Geyer
 * @version 1.0
 */
public class InputJavadocStyleHtmlComment
{
    /**
     * sometimes a tag starts
     * <pre>
     * somewhere and has a comment in the middle
     * <!-- ignore this -->
     * and ends afterwards
     * </pre>
     */
    private void method1()
    { // JavadocStyle should not report any error for this method
    }

    /**
     * sometimes a tag starts
     * <pre>
     * somewhere and has a multiline comment in the middle
     * <!-- ignore this 
     * spanning
     * multiple lines -->
     * and ends afterwards
     * </pre>
     */
    private void method2()
    { // JavadocStyle should not report any error for this method
    }

    /**
     * sometimes a tag starts
     * <pre>
     * somewhere and has a multiline comment in the middle
     * <!-- ignore this 
     * spanning
     * multiple lines --></pre>
     * and ends on the same line
     */
    private void method3()
    { // JavadocStyle should not report any error for this method
    }
    
    /**
     * sometimes a tag starts
     * <pre>
     * somewhere and has a comment in the middle
     * <!-- ignore this --> with text following
     * and ends afterwards
     * </pre>
     */
    private void method4()
    { // JavadocStyle should not report any error for this method
    }
    
    /**
     * sometimes a tag starts
     * <pre><!-- ignore this --></pre>
     * and ends with a comment in the middle
     */
    private void method5()
    { // JavadocStyle should not report any error for this method
    }

    /**
     * Parameterized interface.
     * @param <I>
     */
    interface Interface<I> {}
}