JDK-8263468 : New page for "recent" new API
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 17
  • Priority: P3
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2021-03-11
  • Updated: 2021-09-24
  • Resolved: 2021-06-08
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 17
17 b26Fixed
Related Reports
CSR :  
JDK-8265055 - Add javadoc options for "recent API" page
Duplicate :  
JDK-8233654 - index/summary page for elements with recent @since entries
Relates :  
JDK-8274295 - Update the javadoc man page to reflect JDK 17 changes
Relates :  
JDK-8268422 - Determine range of "new" javadoc API elements for JDK 18
Sub Tasks
JDK-8269400 :  
Release Note: New Page for "New API" and Improved "Deprecated" Page - Closed
Description
It would be good to generate a summary page for recent new API, perhaps filtered according to values of `@since`.

Generating the page should be relatively easy. Deciding on the contents may beholder. First, note that the value `@since` has no defined semantics: we use a simple version number; other people might use a longer dotted number, others might use a date.

One possible would be a command line option to give a list or regex for the values of `@since` to be included on the page.  We might still have trouble (for JDK) deciding between "new since last release" and "new since last LTS release".

A very different solution would be a different doclet (or a variant of the current doclet!) that *just* produces an API page that links into the main docs.
Comments
Changeset: dc6c96bb Author: Hannes Wallnöfer <hannesw@openjdk.org> Date: 2021-06-08 18:22:16 +0000 URL: https://git.openjdk.java.net/jdk/commit/dc6c96bbaf1c0af3eacaa2e59646ed7c5bb0767d
08-06-2021
I would like to go with the multiple `-since TITLE:RELEASE,...` option format proposed by [~jjg] in the first comment above as it is both simple and flexible (allowing versions to be handled both as multiple pages and table tabs). While the combined title/id format has the benefit of conciseness, it would cause problems (or even make the feature unusable) for anybody using commas or colons as part of their release titles or ids. However, colons and commas in release identifiers are probably uncommon enough to make that restriction acceptable.
12-04-2021
Yes, I think this works better: http://cr.openjdk.java.net/~hannesw/8263468/api.01/new-list.html
17-03-2021
That didn't work very well. I'm going with the one "New API" page per release scheme you suggested.
17-03-2021
My first approach was to generate a single page for all new APIs and use the second column to indicate when the item was added. http://cr.openjdk.java.net/~hannesw/8263468/api.00/new-list.html I think having everything on one page has some benefits, but with this much content it gets a bit confusing, especially since new APIs are listed alphabetically and not by the release they were added. My next approach would be to generate one set of new API tables per release, each with an appropriate heading such as "New in Release 16".
17-03-2021
General brainstorming ideas: Allow one or more options of the form: --since TITLE:COMMA-LIST-OF-SINCE e.g. -since "Last Release:16" -since "Last LTS Release:12,13,14,15,16" If more than one option is given, then one page is generated for each. The NEW link in the navbar goes to the first, all "new API" pages" are listed on each "new API" page. (These are just ideas; not specific proposals)
12-03-2021