langtools/test/com/sun/javadoc/testTaglets/TestTaglets.java
author jjg
Wed, 16 Apr 2014 16:17:09 -0700
changeset 23971 f5ff1f5a8dee
parent 21478 fa4c7cda1b41
child 24065 fc4022e50129
permissions -rw-r--r--
8031649: Clean up javadoc tests Reviewed-by: jjg Contributed-by: neil.toda@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
     2
 * Copyright (c) 2003, 2014, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
06bc494ca11e Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 3890
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 3890
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 3890
diff changeset
    21
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    22
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    23
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
/*
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
 * @test
21008
af0b915df7cc 8025633: Fix javadoc to generate valid anchor names
bpatel
parents: 7681
diff changeset
    26
 * @bug      4654308 4767038 8025633
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @summary  Use a Taglet and include some inline tags such as {@link}.  The
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 *           inline tags should be interpreted properly.
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 *           Run Javadoc on some sample source that uses {@inheritDoc}.  Make
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 *           sure that only the first sentence shows up in the summary table.
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 * @author   jamieh
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * @library  ../lib/
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 * @build    JavadocTester
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 * @build    TestTaglets
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
 * @build    taglets.Foo
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
 * @run main TestTaglets
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
public class TestTaglets extends JavadocTester {
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
    //Test information.
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
    private static final String BUG_ID = "4654308-4767038";
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
    private static final String OUTPUT_DIR = BUG_ID;
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
    //Javadoc arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
    private static final String[] ARGS_4654308 = new String[] {
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
        "-d", "4654308", "-tagletpath", SRC_DIR, "-taglet", "taglets.Foo",
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    48
        "-sourcepath", SRC_DIR, SRC_DIR + "/C.java"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
    private static final String[] ARGS_4767038 = new String[] {
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    52
        "-d", "4767038", "-sourcepath", SRC_DIR, SRC_DIR + "/Parent.java",
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    53
        SRC_DIR + "/Child.java"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
    //Input for string search tests.
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
    private static final String[][] TEST_4654308 = new String[][] {
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    58
        {"4654308/C.html", "<span class=\"simpleTagLabel\">Foo:</span></dt>" +
21008
af0b915df7cc 8025633: Fix javadoc to generate valid anchor names
bpatel
parents: 7681
diff changeset
    59
                 "<dd>my only method is <a href=\"C.html#method--\"><code>here" +
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    60
                 "</code></a></dd></dl>"}
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
    private static final String[][] NEGATED_TEST_4654308 = NO_TEST;
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
    private static final String[][] TEST_4767038 = new String[][] {
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    65
        {"4767038/Child.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    66
            "This is the first sentence."}
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
    private static final String[][] NEGATED_TEST_4767038 = NO_TEST;
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
     * The entry point of the test.
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
     * @param args the array of command line arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
    public static void main(String[] args) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
        TestTaglets tester = new TestTaglets();
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
        run(tester, ARGS_4654308, TEST_4654308, NEGATED_TEST_4654308);
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
        tester.printSummary();
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
        tester = new TestTaglets();
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
        run(tester, ARGS_4767038, TEST_4767038, NEGATED_TEST_4767038);
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
        tester.printSummary();
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
    public String getBugId() {
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
        return BUG_ID;
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
    public String getBugName() {
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
        return getClass().getName();
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
}