RFR: 8323698: Class use page does not include extends/implements type arguments

Hannes Wallnöfer hannesw at openjdk.org
Mon Jan 22 14:43:30 UTC 2024


On Sun, 14 Jan 2024 01:00:36 GMT, Chen Liang <liach at openjdk.org> wrote:

> Currently in the javadoc tool, the generated class use page does not track the occurrences of a class in the type arguments of the extends or implements list, where they can appear. (See more details on the JBS issue) For example:
> 
> public class One {}
> 
> 
> import java.util.*;
> public class Two extends ArrayList<One> implements Comparator<One> {
> }
> 
> 
> This patch proposes to add new 2 usage categories, "Classes that extend types with arguments of type" and "Classes that implement types with arguments of type" to describe the missing usage scenarios.
> 
> A preview of the new use page with the 2 new categories, generated based on the example above, can be found here: https://cr.openjdk.org/~liach/8323698-javadocuse/doc/class-use/One.html

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties line 384:

> 382: doclet.ClassUse_TypeParameter=Classes in {1} with type parameters of type {0}
> 383: doclet.ClassUse_SuperclassTypeParameter=Classes in {1} that extend types with arguments of type {0}
> 384: doclet.ClassUse_InterfaceTypeParameter=Classes in {1} that implement types with arguments of type {0}

Not sure about the wording here: I think it should be "type arguments" instead of just "arguments", and maybe "extend classes" and "implement interfaces"?

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

PR Review Comment: https://git.openjdk.org/jdk/pull/17414#discussion_r1461961071


More information about the javadoc-dev mailing list