[jdk17] RFR: JDK-8259499: Handling type arguments from outer classes for inner class in javadoc

[liach]

On Thu, 1 Jul 2021 13:50:25 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

> This change adds support for generating HTML links to the type arguments of enclosing classes when creating a link to an inner class. Previously, only a link to the inner class was created and the type arguments were even omitted from the link label.
> 
> The new feature to create separate links to the enclosing class and its type arguments is only activated if the enclosing class has type arguments. If the enclosing class is non-generic, the old behavior is preserved to create a single link to the inner class. The reason for this is that a dedicated link to the enclosing class itself provides little benefit, since it can be easily reached via the "Enclosing class" link of the inner class. Also, linking the enclosing type in absence of type arguments makes it hard to see that there are two links and easy to click on the wrong link by mistake.
> 
> On the other hand, for type arguments a separate link should be useful since it is often not a "nearby" type. It is also easier to detect the different links than for non-generic nested classes. I came to like this "mixed" solution best after trying several other approaches.

Thank you for addressing an issue I've reported!

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlLinkInfo.java line 31:

> 29: import javax.lang.model.element.ExecutableElement;
> 30: import javax.lang.model.element.TypeElement;
> 31: import javax.lang.model.type.DeclaredType;

Extraneous import

test/langtools/jdk/javadoc/doclet/testGenericTypeLink/pkg1/A.java line 65:

> 63:     /**
> 64:      * @see A<String, java.lang.RuntimeException>.Inner
> 65:      * @see A<A<String, java.lang.RuntimeException>.Inner, A.SomeException>

Is this a new feature that we can link with type arguments? Interesting, as https://docs.oracle.com/en/java/javase/16/docs/specs/javadoc/doc-comment-spec.html#see has no mention on usage of type arguments in see links.

-------------

PR: https://git.openjdk.java.net/jdk17/pull/195