RFR: 8280713: Related to comment inheritance jdk.javadoc cleanup and refactoring [v3]

Jonathan Gibbons jjg at openjdk.java.net
Fri Feb 25 18:50:01 UTC 2022


On Fri, 25 Feb 2022 17:46:05 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

>> Explorative refactoring performed while looking into multiple `@inheritDoc` issues. The easiest way to review it is to, probably, go commit by commit; they are quite focused and commented. Not only the branch as a whole, but all the constituent commits should pass tests and leave JDK API Documentation unchanged.
>
> Pavel Rappo has updated the pull request incrementally with two additional commits since the last revision:
> 
>  - Fix outdated code
>    
>    Uses a set instead of list for quick method search. In a future commit we'll try to figure out why `found` are not unique.
>  - Fix outdated code
>    
>    Fix outdated inline comments and names. Both the assertion and the `contains` method will be removed in a future commit.

Commit: Refactor how superinterfaces are collected

OK

Commit: Refine overriddenType(ExecutableElement)

OK.

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/WorkArounds.java line 218:

> 216:      * that interface extends.
> 217:      */
> 218:     public DeclaredType overriddenType(ExecutableElement method) {

I like the use of the more specific `DeclaredType`

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java line 921:

> 919:             } else {
> 920:                 // there can be at most one superclass and it is not null
> 921:                 assert superType == null && t != null : superType;

Maybe consider renaming `superType` to `superClass`

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

PR: https://git.openjdk.java.net/jdk/pull/7233


More information about the javadoc-dev mailing list