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

[Jonathan Gibbons]

On Mon, 30 May 2022 15:16:07 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
>
> test/langtools/jdk/javadoc/doclet/testRecordTypes/TestRecordTypes.java line 610:
> 
>> 608: 
>> 609:     @Test
>> 610:     public void testPackageTree(Path base) throws IOException {
> 
> Am I right saying that we cannot easily test the original bug symptom, which is the presence of "Direct Known Subclasses:" on the api/java.base/java/lang/Record.html page?

Yes, that is a specific test on a specific page in the JDK API documentation.

A possible test would involve ensuring access to the `src/` directory, and then maybe running javadoc on a subset of APIs, such as `java.lang.*` with maybe dummy placeholders for JDK custom tags, like `@jls`, `@jvms`, `@moduleGraph` etc.  It might then be a "good enough" test on `Record.html` even if it is not the actual page in the full documentation.

See also the comments labelled _Testing_ in the main description of this PR.

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

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