stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8302324: Inheritance tree does not show correct type parameters/arguments

Browse Source 
Reviewed-by: prappo
This commit is contained in:
Hannes Wallnöfer 2023-02-14 12:42:59 +00:00
parent 7dfe75cf55
commit 6d4b02b6c9
2 changed files with 122 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java
View File

@ -1093,22 +1093,8 @@ public class Utils {
* be found.
*/
public TypeMirror getFirstVisibleSuperClass(TypeMirror type) {
return getFirstVisibleSuperClass(asTypeElement(type));
}
/**
* Given a class, return the closest visible superclass.
*
* @param te the TypeElement to be interrogated
* @return the closest visible superclass. Return null if it cannot
* be found.
*/
public TypeMirror getFirstVisibleSuperClass(TypeElement te) {
TypeMirror superType = te.getSuperclass();
if (isNoType(superType)) {
superType = getObjectType();
}
List<? extends TypeMirror> superTypes = typeUtils.directSupertypes(type);
TypeMirror superType = superTypes.isEmpty() ? getObjectType() : superTypes.get(0);
TypeElement superClass = asTypeElement(superType);
// skip "hidden" classes
while ((superClass != null && hasHiddenTag(superClass))
@ -1122,12 +1108,24 @@ public class Utils {
superType = supersuperType;
superClass = supersuperClass;
}
if (typeUtils.isSameType(te.asType(), superType)) {
if (typeUtils.isSameType(type, superType)) {
return null;
}
return superType;
}
/**
* Given a class, return the closest visible superclass.
*
* @param te the TypeElement to be interrogated
* @return the closest visible superclass. Return null if it cannot
* be found.
*/
public TypeMirror getFirstVisibleSuperClass(TypeElement te) {
return getFirstVisibleSuperClass(te.asType());
}
/**
* Returns the name of the kind of a type element (Class, Interface, etc.).
*

107
test/langtools/jdk/javadoc/doclet/testInheritance/TestInheritance.java Normal file
View File

@ -0,0 +1,107 @@
/*
* Copyright (c) 2023, 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 8302324
* @summary Inheritance tree does not show correct type parameters/arguments
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build toolbox.ToolBox javadoc.tester.*
* @run main TestInheritance
*/
import java.nio.file.Path;
import javadoc.tester.JavadocTester;
import toolbox.ToolBox;
public class TestInheritance extends JavadocTester {
public static void main(String... args) throws Exception {
var test = new TestInheritance();
test.runTests();
}
@Test
public void testInheritanceGeneric(Path base) throws Exception {
Path src = base.resolve("src");
new ToolBox().writeJavaFiles(src, """
package pkg;
/**
* Base class
* @param <M> param M
* @param <N> param N
*/
public class A<M, N> { private A() { } }
""",
"""
package pkg;
/**
* First subclass
* @param <O> param O
* @param <P> param P
*/
public class B<O, P> extends A<O, P> { private B() { } }
""",
"""
package pkg;
/**
* Second subclass
* @param <Q> param Q
*/
public class C<Q> extends B<String, Q> { private C() { } }
""",
"""
package pkg;
/**
* Second subclass
* @param <R> param R
* @param <S> param S
*/
public class D<R, S> extends B<S, B> { private D() { } }
""");
javadoc("-d", base.resolve("docs").toString(),
"-sourcepath", src.toString(),
"--no-platform-links",
"pkg");
checkExit(Exit.OK);
checkOrder("pkg/A.html", """
<div class="inheritance" title="Inheritance Tree">java.lang.Object
<div class="inheritance">pkg.A&lt;M,<wbr>N&gt;</div>""");
checkOrder("pkg/B.html", """
<div class="inheritance" title="Inheritance Tree">java.lang.Object
<div class="inheritance"><a href="A.html" title="class in pkg">pkg.A</a>&lt;O,<wbr>P&gt;
<div class="inheritance">pkg.B&lt;O,<wbr>P&gt;</div>""");
checkOrder("pkg/C.html", """
<div class="inheritance" title="Inheritance Tree">java.lang.Object
<div class="inheritance"><a href="A.html" title="class in pkg">pkg.A</a>&lt;java.lang.String,<wbr>Q&gt;
<div class="inheritance"><a href="B.html" title="class in pkg">pkg.B</a>&lt;java.lang.String,<wbr>Q&gt;
<div class="inheritance">pkg.C&lt;Q&gt;</div>""");
checkOrder("pkg/D.html", """
<div class="inheritance" title="Inheritance Tree">java.lang.Object
<div class="inheritance"><a href="A.html" title="class in pkg">pkg.A</a>&lt;S,<wbr><a href="B.html" title="class in pkg">B</a>&gt;
<div class="inheritance"><a href="B.html" title="class in pkg">pkg.B</a>&lt;S,<wbr><a href="B.html" title="class in pkg">B</a>&gt;
<div class="inheritance">pkg.D&lt;R,<wbr>S&gt;</div>""");
}
}