RFR: JDK-8285939: javadoc java.lang.Record should not have "Direct Known Subclasses:" section [v3]

[Jonathan Gibbons]

On Mon, 30 May 2022 13:41:33 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

>> Jonathan Gibbons has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains five commits:
>> 
>>  - Merge remote-tracking branch 'upstream/master' into 8285939.record-subtypes
>>  - address review comments: add doc comments to new methods
>>  - merge with upstream master
>>  - fix copyright; update test description
>>  - JDK-8285939: javadoc java.lang.Record should not have "Direct Known Subclasses:" section
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/ClassTree.java line 78:
> 
>> 76:         /**
>> 77:          * {@return the roots of the hierarchy}
>> 78:          * The roots are the classes or interfaces with no superclass or superinterfaces.
> 
> Use singular "root" for clarity:
> Suggestion:
> 
>          * A root is a class or an interface with no superclass or superinterfaces.

OK

> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/ClassTree.java line 88:
> 
>> 86:          * {@return a map containing the type elements in this hierarchy and their subtypes}
>> 87:          */
>> 88:         public Map<TypeElement, SortedSet<TypeElement>> subtypes() {
> 
> This method is unused; consider deleting it.

OK

> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/ClassTree.java line 103:
> 
>> 101:          * {@return the set of all subtypes of the given type element, or an empty set if there are none}
>> 102:          *
>> 103:          * The set of all subtypes is the transitive closure of the {@linkplain #subtypes() immediate subtypes}
> 
> Did you mean to link to #subtypes(TypeElement)?

I had meant `#subtypes()` but now that that method has been deleted, `#subtypes(TypeElement)` will have to do.

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

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