| /* |
| * Copyright (c) 2003, 2016, Oracle and/or its affiliates. All rights reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| |
| /* |
| * @test |
| * @bug 4780441 4874845 4978816 8014017 8016328 8025633 8026567 |
| * @summary Make sure that when the -private flag is not used, members |
| * inherited from package private class are documented in the child. |
| * |
| * Make sure that when a method inherits documentation from a method |
| * in a non-public class/interface, the non-public class/interface |
| * is not mentioned anywhere (not even in the signature or tree). |
| * |
| * Make sure that when a private interface method with generic parameters |
| * is implemented, the comments can be inherited properly. |
| * |
| * Make sure when no modifier appear in the class signature, the |
| * signature is displayed correctly without extra space at the beginning. |
| * @author jamieh |
| * @library ../lib |
| * @modules jdk.javadoc/jdk.javadoc.internal.tool |
| * @build JavadocTester |
| * @run main TestPrivateClasses |
| */ |
| |
| public class TestPrivateClasses extends JavadocTester { |
| |
| public static void main(String... args) throws Exception { |
| TestPrivateClasses tester = new TestPrivateClasses(); |
| tester.runTests(); |
| } |
| |
| @Test |
| void testDefault() { |
| javadoc("-d", "out-default", |
| "-sourcepath", testSrc, |
| "pkg", "pkg2"); |
| checkExit(Exit.OK); |
| |
| checkOutput("pkg/PublicChild.html", true, |
| // Field inheritence from non-public superclass. |
| "<a href=\"../pkg/PublicChild.html#fieldInheritedFromParent\">" |
| + "fieldInheritedFromParent</a>", |
| // Method inheritance from non-public superclass. |
| "<a href=\"../pkg/PublicChild.html#methodInheritedFromParent-int-\">" |
| + "methodInheritedFromParent</a>", |
| // private class does not show up in tree |
| "<ul class=\"inheritance\">\n" |
| + "<li>java.lang.Object</li>\n" |
| + "<li>\n" |
| + "<ul class=\"inheritance\">\n" |
| + "<li>pkg.PublicChild</li>\n" |
| + "</ul>\n" |
| + "</li>\n" |
| + "</ul>", |
| // Method is documented as though it is declared in the inheriting method. |
| "<pre>public void methodInheritedFromParent(int p1)", |
| "<dl>\n" |
| + "<dt>All Implemented Interfaces:</dt>\n" |
| + "<dd><a href=\"../pkg/PublicInterface.html\" title=\"interface in pkg\">" |
| + "PublicInterface</a></dd>\n" |
| + "</dl>"); |
| |
| checkOutput("pkg/PublicChild.html", false, |
| // Should not document that a method overrides method from private class. |
| "<span class=\"overrideSpecifyLabel\">Overrides:</span>", |
| // Should not document that a method specified by private interface. |
| "<span class=\"overrideSpecifyLabel\">Specified by:</span>", |
| // Should not mention that any documentation was copied. |
| "Description copied from", |
| // Don't extend private classes or interfaces |
| "PrivateParent", |
| "PrivateInterface"); |
| |
| checkOutput("pkg/PublicChild.html", false, |
| // Should not document comments from private inherited interfaces |
| "<td class=\"colLast\"><code><span class=\"memberNameLink\">" + |
| "<a href=\"../pkg/PublicChild.html#methodInterface-int-\">" + |
| "methodInterface</a></span>(int p1)</code>\n" + |
| "<div class=\"block\">Comment from interface.</div>\n</td>", |
| // and similarly one more |
| "<td class=\"colLast\"><code><span class=\"memberNameLink\">" + |
| "<a href=\"../pkg/PublicChild.html#methodInterface2-int-\">" + |
| "methodInterface2</a></span>(int p1)</code>\n" + |
| "<div class=\"block\">Comment from interface.</div>\n</td>" |
| ); |
| |
| checkOutput("pkg/PublicInterface.html", true, |
| // Field inheritance from non-public superinterface. |
| "<a href=\"../pkg/PublicInterface.html#fieldInheritedFromInterface\">" |
| + "fieldInheritedFromInterface</a>", |
| // Method inheritance from non-public superinterface. |
| "<a href=\"../pkg/PublicInterface.html#methodInterface-int-\">" |
| + "methodInterface</a>", |
| //Make sure implemented interfaces from private superclass are inherited |
| "<dl>\n" |
| + "<dt>All Known Implementing Classes:</dt>\n" |
| + "<dd><a href=\"../pkg/PublicChild.html\" title=\"class in pkg\">" |
| + "PublicChild</a></dd>\n" |
| + "</dl>"); |
| |
| checkOutput("pkg/PublicInterface.html", false, |
| "<span class=\"overrideSpecifyLabel\">Specified by:</span>", |
| "Description copied from", |
| "PrivateInterface", |
| "All Superinterfaces"); |
| |
| checkOutput("pkg2/C.html", false, |
| //Generic interface method test. |
| "This comment should get copied to the implementing class"); |
| |
| checkOutput("pkg2/C.html", false, |
| //Do not inherit private interface method with generic parameters. |
| //This method has been implemented. |
| "<span class=\"memberNameLink\"><a href=\"../pkg2/I.html#hello-T-\">hello</a></span>"); |
| |
| checkOutput("constant-values.html", false, |
| // Make inherited constant are documented correctly. |
| "PrivateInterface"); |
| } |
| |
| @Test |
| void testPrivate() { |
| javadoc("-d", "out-private", |
| "-sourcepath", testSrc, |
| "-private", |
| "pkg", "pkg2"); |
| checkExit(Exit.OK); |
| |
| checkOutput("pkg/PublicChild.html", true, |
| // Field inheritence from non-public superclass. |
| "Fields inherited from class pkg." |
| + "<a href=\"../pkg/PrivateParent.html\" title=\"class in pkg\">" |
| + "PrivateParent</a>", |
| "<a href=\"../pkg/PrivateParent.html#fieldInheritedFromParent\">" |
| + "fieldInheritedFromParent</a>", |
| // Method inheritence from non-public superclass. |
| "Methods inherited from class pkg." |
| + "<a href=\"../pkg/PrivateParent.html\" title=\"class in pkg\">" |
| + "PrivateParent</a>", |
| "<a href=\"../pkg/PrivateParent.html#methodInheritedFromParent-int-\">" |
| + "methodInheritedFromParent</a>", |
| // Should document that a method overrides method from private class. |
| "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n" |
| + "<dd><code><a href=\"../pkg/PrivateParent.html#methodOverridenFromParent-char:A-int-T-V-java.util.List-\">" |
| + "methodOverridenFromParent</a></code> in class <code>" |
| + "<a href=\"../pkg/PrivateParent.html\" title=\"class in pkg\">" |
| + "PrivateParent</a></code></dd>", |
| // Should document that a method is specified by private interface. |
| "<dt><span class=\"overrideSpecifyLabel\">Specified by:</span></dt>\n" |
| + "<dd><code><a href=\"../pkg/PrivateInterface.html#methodInterface-int-\">" |
| + "methodInterface</a></code> in interface <code>" |
| + "<a href=\"../pkg/PrivateInterface.html\" title=\"interface in pkg\">" |
| + "PrivateInterface</a></code></dd>", |
| // Should mention that any documentation was copied. |
| "Description copied from", |
| // Extend documented private classes or interfaces |
| "extends", |
| "<dl>\n" |
| + "<dt>All Implemented Interfaces:</dt>\n" |
| + "<dd><a href=\"../pkg/PrivateInterface.html\" title=\"interface in pkg\">" |
| + "PrivateInterface</a>, " |
| + "<a href=\"../pkg/PublicInterface.html\" title=\"interface in pkg\">" |
| + "PublicInterface</a></dd>\n" |
| + "</dl>", |
| "<pre>public class <span class=\"typeNameLabel\">PublicChild</span>"); |
| |
| checkOutput("pkg/PublicInterface.html", true, |
| // Field inheritence from non-public superinterface. |
| "Fields inherited from interface pkg." |
| + "<a href=\"../pkg/PrivateInterface.html\" title=\"interface in pkg\">" |
| + "PrivateInterface</a>", |
| "<a href=\"../pkg/PrivateInterface.html#fieldInheritedFromInterface\">" |
| + "fieldInheritedFromInterface</a>", |
| // Method inheritance from non-public superinterface. |
| "Methods inherited from interface pkg." |
| + "<a href=\"../pkg/PrivateInterface.html\" title=\"interface in pkg\">" |
| + "PrivateInterface</a>", |
| // Extend documented private classes or interfaces |
| "extends", |
| "All Superinterfaces", |
| //Make sure implemented interfaces from private superclass are inherited |
| "<dl>\n" |
| + "<dt>All Known Implementing Classes:</dt>\n" |
| + "<dd><a href=\"../pkg/PrivateParent.html\" title=\"class in pkg\">" |
| + "PrivateParent</a>, " |
| + "<a href=\"../pkg/PublicChild.html\" title=\"class in pkg\">PublicChild" |
| + "</a></dd>\n" |
| + "</dl>"); |
| |
| checkOutput("pkg/PrivateInterface.html", true, |
| "<a href=\"../pkg/PrivateInterface.html#methodInterface-int-\">" |
| + "methodInterface</a>" |
| ); |
| |
| checkOutput("pkg2/C.html", true, |
| //Since private flag is used, we can document that private interface method |
| //with generic parameters has been implemented. |
| "<span class=\"descfrmTypeLabel\">Description copied from interface: <code>" |
| + "<a href=\"../pkg2/I.html#hello-T-\">I</a></code></span>", |
| "<dt><span class=\"overrideSpecifyLabel\">Specified by:</span></dt>\n" |
| + "<dd><code><a href=\"../pkg2/I.html#hello-T-\">hello</a></code>" |
| + " in interface <code>" |
| + "<a href=\"../pkg2/I.html\" title=\"interface in pkg2\">I</a>" |
| + "<java.lang.String></code></dd>"); |
| |
| checkOutput("pkg/PrivateParent.html", true, |
| //Make sure when no modifier appear in the class signature, the |
| //signature is displayed correctly without extra space at the beginning. |
| "<pre>class <span class=\"typeNameLabel\">PrivateParent</span>"); |
| |
| checkOutput("pkg/PrivateParent.html", false, |
| "<pre> class <span class=\"typeNameLabel\">PrivateParent</span>"); |
| } |
| } |
