test/jdk/javadoc/doclet/testInterface/TestInterface.java
Print this page
@@ -1,7 +1,7 @@
/*
- * Copyright (c) 2003, 2015, Oracle and/or its affiliates. All rights reserved.
+ * 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.
@@ -21,11 +21,11 @@
* questions.
*/
/*
* @test
- * @bug 4682448 4947464 5029946 8025633 8026567
+ * @bug 4682448 4947464 5029946 8025633 8026567 8035473
* @summary Verify that the public modifier does not show up in the
* documentation for public methods, as recommended by the JLS.
* If A implements I and B extends A, B should be in the list of
* implementing classes in the documentation for I.
* @author jamieh
@@ -33,10 +33,24 @@
* @modules jdk.javadoc
* @build JavadocTester
* @run main TestInterface
*/
+/*
+ * TODO: make it Inteferface<PE> ie. fix all ParameterTypes, likely should get
+ * fixed when Doc is replace by j.l.m, but meanwhile this test has been adjusted
+ * take the current format this is better than @ignore because we can follow the
+ * differences as the work progress.
+ *
+ * The consensus is that we should have something as follows:
+ * In Child.html
+ * Specified by: method in interface<IE>
+ * Overrides: method in class Parent<PE>
+ * In otherwords the TypeParameter in scope should be used ex: Interface<IE>, Parent<PE>
+ and Child<CE>
+ */
+
public class TestInterface extends JavadocTester {
public static void main(String... args) throws Exception {
TestInterface tester = new TestInterface();
tester.runTests();
@@ -63,22 +77,22 @@
checkOutput("pkg/Child.html", true,
// Make sure "All Implemented Interfaces": has substituted type parameters
"<dl>\n"
+ "<dt>All Implemented Interfaces:</dt>\n"
+ "<dd><a href=\"../pkg/Interface.html\" title=\"interface in pkg\">"
- + "Interface</a><T></dd>\n"
+ + "Interface</a><CE></dd>\n"
+ "</dl>",
//Make sure Class Tree has substituted type parameters.
"<ul class=\"inheritance\">\n"
+ "<li>java.lang.Object</li>\n"
+ "<li>\n"
+ "<ul class=\"inheritance\">\n"
+ "<li><a href=\"../pkg/Parent.html\" title=\"class in pkg\">"
- + "pkg.Parent</a><T></li>\n"
+ + "pkg.Parent</a><CE></li>\n"
+ "<li>\n"
+ "<ul class=\"inheritance\">\n"
- + "<li>pkg.Child<T></li>\n"
+ + "<li>pkg.Child<CE></li>\n"
+ "</ul>\n"
+ "</li>\n"
+ "</ul>\n"
+ "</li>\n"
+ "</ul>",
@@ -86,17 +100,17 @@
"<dt><span class=\"overrideSpecifyLabel\">Specified by:</span></dt>\n"
+ "<dd><code><a href=\"../pkg/Interface.html#method--\">method</a>"
+ "</code> in interface <code>"
+ "<a href=\"../pkg/Interface.html\" title=\"interface in pkg\">"
+ "Interface</a><<a href=\"../pkg/Child.html\" title=\"type parameter in Child\">"
- + "T</a>></code></dd>",
+ + "CE</a>></code></dd>",
//Make sure "Overrides" has substituted type parameters.
"<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
+ "<dd><code><a href=\"../pkg/Parent.html#method--\">method</a>"
+ "</code> in class <code><a href=\"../pkg/Parent.html\" "
+ "title=\"class in pkg\">Parent</a><<a href=\"../pkg/Child.html\" "
- + "title=\"type parameter in Child\">T</a>></code></dd>");
+ + "title=\"type parameter in Child\">CE</a>></code></dd>");
checkOutput("pkg/Parent.html", true,
//Make sure "Direct Know Subclasses" omits type parameters
"<dl>\n"
+ "<dt>Direct Known Subclasses:</dt>\n"
@@ -106,6 +120,51 @@
checkOutput("pkg/Interface.html", false,
"public int method()",
"public static final int field");
}
+
+ @Test
+ void test1() {
+ javadoc("-d", "out-1",
+ "-sourcepath", testSrc,
+ "pkg1");
+ checkExit(Exit.OK);
+
+ checkOutput("pkg1/Child.html", true,
+ // Ensure the correct Overrides in the inheritance hierarchy is reported
+ "<span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n" +
+ "<dd><code><a href=\"../pkg1/GrandParent.html#method1--\">method1</a></code>" +
+ " in class " +
+ "<code><a href=\"../pkg1/GrandParent.html\" title=\"class in pkg1\">GrandParent</a>" +
+ "<<a href=\"../pkg1/Child.html\" title=\"type parameter in Child\">CE</a>></code>");
+ }
+
+ @Test
+ void test2() {
+ javadoc("-d", "out-2",
+ "-sourcepath", testSrc,
+ "pkg2");
+
+ checkExit(Exit.OK);
+
+ checkOutput("pkg2/Spliterator.OfDouble.html", true,
+ // Ensure the correct type parameters are displayed correctly
+ "<h3>Nested classes/interfaces inherited from interface pkg2."
+ + "<a href=\"../pkg2/Spliterator.html\" title=\"interface in pkg2\">Spliterator</a></h3>\n" +
+ "<code><a href=\"../pkg2/Spliterator.OfDouble.html\" title=\"interface in pkg2\">"
+ + "Spliterator.OfDouble</a>, <a href=\"../pkg2/Spliterator.OfInt.html\" "
+ + "title=\"interface in pkg2\">Spliterator.OfInt</a><"
+ + "<a href=\"../pkg2/Spliterator.OfInt.html\" title=\"type parameter in Spliterator.OfInt\">"
+ + "Integer</a>>, <a href=\"../pkg2/Spliterator.OfPrimitive.html\" title=\"interface in pkg2\">"
+ + "Spliterator.OfPrimitive</a><<a href=\"../pkg2/Spliterator.OfPrimitive.html\" "
+ + "title=\"type parameter in Spliterator.OfPrimitive\">T</a>,<a href=\"../pkg2/Spliterator.OfPrimitive.html\" "
+ + "title=\"type parameter in Spliterator.OfPrimitive\">T_CONS</a>,"
+ + "<a href=\"../pkg2/Spliterator.OfPrimitive.html\" title=\"type parameter in Spliterator.OfPrimitive\">"
+ + "T_SPLITR</a> extends <a href=\"../pkg2/Spliterator.OfPrimitive.html\" title=\"interface in pkg2\">"
+ + "Spliterator.OfPrimitive</a><<a href=\"../pkg2/Spliterator.OfPrimitive.html\" "
+ + "title=\"type parameter in Spliterator.OfPrimitive\">T</a>,"
+ + "<a href=\"../pkg2/Spliterator.OfPrimitive.html\" title=\"type parameter in Spliterator.OfPrimitive\">"
+ + "T_CONS</a>,<a href=\"../pkg2/Spliterator.OfPrimitive.html\" title=\"type parameter in Spliterator.OfPrimitive\">"
+ + "T_SPLITR</a>>></code>");
+ }
}