RFR: JDK-8263468: New page for "recent" new API [v2]

Jonathan Gibbons jjg at openjdk.java.net
Mon Jun 7 15:54:18 UTC 2021


On Fri, 28 May 2021 08:19:33 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

>> This adds a new kind of summary list for new API added in specific releases, and adds information to the deprecated API list about elements that were deprecated in the given releases.
>> 
>> The changes to the code are relatively minor thanks to the existing infrastructure for summary list pages, which was extended by adding the `getTableCaption` and `addTableTabs` methods to `SummaryListWriter.java` in order to generate tabbed tables. 
>> 
>> One important area that needs to be reviewed is the addition of resources in `standard.properties`. A relatively big share of discussion and effort went into shaping the UI messages.
>> 
>> The build system change adds options to generate API changes for all releases after JDK 11, with "New API since JDK 11" as page title for the new API page. I uploaded the generated documentation here:
>> 
>> http://cr.openjdk.java.net/~hannesw/8263468/api-pr.00/new-list.html
>> http://cr.openjdk.java.net/~hannesw/8263468/api-pr.00/deprecated-list.html
>
> Hannes Wallnöfer has updated the pull request incrementally with one additional commit since the last revision:
> 
>   JDK-8263468: automate build integration

Some minor suggestions for your consideration

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

> 110: doclet.Deprecated_Tabs_Intro=(The leftmost tab "Deprecated ..." indicates all the \
> 111:     deprecated elements, regardless of the releases in which they were deprecated. \
> 112:     Each of the righthand tabs "Deprecated in ..." indicates the elements deprecated \

"Each of the righthand" doesn't read well.   Would "Each of the other" be better?

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

> 117: doclet.New_Label=New
> 118: doclet.New_Tabs_Intro=(The leftmost tab "New ..." indicates all the new elements, \
> 119:     regardless of the releases in which they were added. Each of the righthand \

ditto

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

> 266: doclet.help.new.body=\
> 267:     The {0} page lists APIs that have been added in recent releases. \
> 268:     The content of this page is based on information provided by Javadoc @since tags.

Either change to "JavaDoc" or (preferably?) just delete this word, or even the sentence.

Is there any interaction with `-nosince`? Should there be?

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Extern.java line 337:

> 335:      */
> 336:     public int getSourceVersionNumber() {
> 337:         return configuration.docEnv.getSourceVersion().ordinal();

As a general comment, I believe Joe does not encourage use of `ordinal`

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

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



More information about the build-dev mailing list