Wed, 01 Dec 2010 11:02:38 -0800
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
Reviewed-by: jjg
duke@1 | 1 | /* |
ohair@554 | 2 | * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
duke@1 | 7 | * published by the Free Software Foundation. |
duke@1 | 8 | * |
duke@1 | 9 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 10 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 12 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 13 | * accompanied this code). |
duke@1 | 14 | * |
duke@1 | 15 | * You should have received a copy of the GNU General Public License version |
duke@1 | 16 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 17 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 18 | * |
ohair@554 | 19 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 20 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 21 | * questions. |
duke@1 | 22 | */ |
duke@1 | 23 | |
duke@1 | 24 | /* |
duke@1 | 25 | * @test |
duke@1 | 26 | * @bug 4634891 |
duke@1 | 27 | * @summary Determine if overriden methods are properly documented when |
duke@1 | 28 | * -protected (default) visibility flag is used. |
duke@1 | 29 | * @author jamieh |
duke@1 | 30 | * @library ../lib/ |
duke@1 | 31 | * @build JavadocTester |
duke@1 | 32 | * @build TestOverridenPrivateMethodsWithPackageFlag |
duke@1 | 33 | * @run main TestOverridenPrivateMethodsWithPackageFlag |
duke@1 | 34 | */ |
duke@1 | 35 | |
duke@1 | 36 | public class TestOverridenPrivateMethodsWithPackageFlag extends JavadocTester { |
duke@1 | 37 | |
duke@1 | 38 | private static final String BUG_ID = "4634891"; |
duke@1 | 39 | |
duke@1 | 40 | private static final String[][] TEST = { |
duke@1 | 41 | //The public method should be overriden |
duke@1 | 42 | {BUG_ID + FS + "pkg1" + FS + "SubClass.html", |
bpatel@766 | 43 | "<dt><strong>Overrides:</strong></dt>" + NL + |
bpatel@766 | 44 | "<dd><code><a href=\"../pkg1/BaseClass.html#publicMethod()\">" + |
bpatel@766 | 45 | "publicMethod</a></code> in class <code>" + |
bpatel@766 | 46 | "<a href=\"../pkg1/BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>"}, |
duke@1 | 47 | |
duke@1 | 48 | //The public method in different package should be overriden |
duke@1 | 49 | {BUG_ID + FS + "pkg2" + FS + "SubClass.html", |
bpatel@766 | 50 | "<dt><strong>Overrides:</strong></dt>" + NL + |
bpatel@766 | 51 | "<dd><code><a href=\"../pkg1/BaseClass.html#publicMethod()\">" + |
bpatel@766 | 52 | "publicMethod</a></code> in class <code>" + |
bpatel@766 | 53 | "<a href=\"../pkg1/BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>"}, |
duke@1 | 54 | |
duke@1 | 55 | //The package private method should be overriden since the base and sub class are in the same |
duke@1 | 56 | //package. |
duke@1 | 57 | {BUG_ID + FS + "pkg1" + FS + "SubClass.html", |
bpatel@766 | 58 | "<dt><strong>Overrides:</strong></dt>" + NL + |
bpatel@766 | 59 | "<dd><code><a href=\"../pkg1/BaseClass.html#packagePrivateMethod()\">" + |
bpatel@766 | 60 | "packagePrivateMethod</a></code> in class <code>" + |
bpatel@766 | 61 | "<a href=\"../pkg1/BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>"} |
duke@1 | 62 | }; |
duke@1 | 63 | |
duke@1 | 64 | private static final String[][] NEGATED_TEST = { |
duke@1 | 65 | |
duke@1 | 66 | //The private method in should not be overriden |
duke@1 | 67 | {BUG_ID + FS + "pkg1" + FS + "SubClass.html", |
bpatel@766 | 68 | "<dt><strong>Overrides:</strong></dt>" + NL + |
bpatel@766 | 69 | "<dd><code><a href=\"../pkg1/BaseClass.html#privateMethod()\">"}, |
duke@1 | 70 | |
duke@1 | 71 | //The private method in different package should not be overriden |
duke@1 | 72 | {BUG_ID + FS + "pkg2" + FS + "SubClass.html", |
bpatel@766 | 73 | "<dt><strong>Overrides:</strong></dt>" + NL + |
bpatel@766 | 74 | "<dd><code><a href=\"../pkg1/BaseClass.html#privateMethod()\">"}, |
duke@1 | 75 | |
duke@1 | 76 | //The package private method should not be overriden since the base and sub class are in |
duke@1 | 77 | //different packages. |
duke@1 | 78 | {BUG_ID + FS + "pkg2" + FS + "SubClass.html", |
bpatel@766 | 79 | "<dt><strong>Overrides:</strong></dt>" + NL + |
bpatel@766 | 80 | "<dd><code><a href=\"../pkg1/BaseClass.html#packagePrivateMethod()\">"}, |
duke@1 | 81 | }; |
duke@1 | 82 | |
duke@1 | 83 | private static final String[] ARGS = |
duke@1 | 84 | new String[] { |
duke@1 | 85 | "-d", BUG_ID, "-sourcepath", SRC_DIR, "-package", "pkg1", "pkg2"}; |
duke@1 | 86 | |
duke@1 | 87 | /** |
duke@1 | 88 | * The entry point of the test. |
duke@1 | 89 | * @param args the array of command line arguments. |
duke@1 | 90 | */ |
duke@1 | 91 | public static void main(String[] args) { |
duke@1 | 92 | TestOverridenPrivateMethodsWithPackageFlag tester = new TestOverridenPrivateMethodsWithPackageFlag(); |
duke@1 | 93 | run(tester, ARGS, TEST, NEGATED_TEST); |
duke@1 | 94 | tester.printSummary(); |
duke@1 | 95 | } |
duke@1 | 96 | |
duke@1 | 97 | /** |
duke@1 | 98 | * {@inheritDoc} |
duke@1 | 99 | */ |
duke@1 | 100 | public String getBugId() { |
duke@1 | 101 | return BUG_ID; |
duke@1 | 102 | } |
duke@1 | 103 | |
duke@1 | 104 | /** |
duke@1 | 105 | * {@inheritDoc} |
duke@1 | 106 | */ |
duke@1 | 107 | public String getBugName() { |
duke@1 | 108 | return getClass().getName(); |
duke@1 | 109 | } |
duke@1 | 110 | } |