langtools/test/com/sun/javadoc/testMemberSummary/TestMemberSummary.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: 1787
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1787
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1787
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
21478
fa4c7cda1b41 8026567: Use meaningful style names for strong and italic styles.
bpatel
parents: 21008
diff changeset
    26
 * @bug      4951228 6290760 8025633 8026567
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @summary  Test the case where the overriden method returns a different
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 *           type than the method in the child class.  Make sure the
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 *           documentation is inherited but the return type isn't.
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 * @author   jamieh
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 * @library  ../lib/
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * @build    JavadocTester
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 * @build    TestMemberSummary
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 * @run main TestMemberSummary
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
public class TestMemberSummary extends JavadocTester {
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
    //Test information.
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
    private static final String BUG_ID = "4951228-6290760";
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
    //Javadoc arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
    private static final String[] ARGS = new String[] {
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
        "-d", BUG_ID, "-sourcepath", SRC_DIR, "pkg","pkg2"
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
    //Input for string search tests.
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
    private static final String[][] TEST = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
        // Check return type in member summary.
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    50
        {BUG_ID + "/pkg/PublicChild.html",
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    51
            "<code><a href=\"../pkg/PublicChild.html\" title=\"class in pkg\">PublicChild</a></code></td>\n" +
21478
fa4c7cda1b41 8026567: Use meaningful style names for strong and italic styles.
bpatel
parents: 21008
diff changeset
    52
            "<td class=\"colLast\"><code><span class=\"memberNameLink\"><a href=\"../pkg/PublicChild.html#returnTypeTest--\">" +
19253
b97b3e18547f 7198274: RFE : Javadoc Accessibility : Use CSS styles rather than <strong> or <i> tags
bpatel
parents: 7681
diff changeset
    53
            "returnTypeTest</a></span>()</code>"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
        },
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
        // Check return type in member detail.
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    56
        {BUG_ID + "/pkg/PublicChild.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    57
            "<pre>public&nbsp;<a href=\"../pkg/PublicChild.html\" title=\"class in pkg\">" +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    58
            "PublicChild</a>&nbsp;returnTypeTest()</pre>"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
        },
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
         // Legacy anchor dimensions (6290760)
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    62
        {BUG_ID + "/pkg2/A.html",
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    63
            "<a name=\"f-java.lang.Object:A-\">\n" +
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    64
            "<!--   -->\n" +
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    65
            "</a><a name=\"f-T:A-\">\n" +
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    66
            "<!--   -->\n" +
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    67
            "</a>"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
        },
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
    private static final String[][] NEGATED_TEST = NO_TEST;
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
     * The entry point of the test.
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
     * @param args the array of command line arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
    public static void main(String[] args) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
        TestMemberSummary tester = new TestMemberSummary();
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
        run(tester, ARGS, TEST, NEGATED_TEST);
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
        tester.printSummary();
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
    public String getBugId() {
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
        return BUG_ID;
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
    public String getBugName() {
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
        return getClass().getName();
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
}