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

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


On Mon, 7 Jun 2021 15:00:43 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 with a new target base due to a merge or a rebase. The pull request now contains 16 commits:
> 
>  - Merge branch 'master' into JDK-8263468
>  - JDK-8263468: automate build integration
>  - JDK-8263468: make constant static
>  - JDK-8263468: Remove unused DocPaths methods
>  - JDK-8263468: Cleanup
>  - JDK-8263468: Add tests
>  - JDK-8263468: Update to new Table methods
>  - Merge branch 'master' into JDK-8263468
>    
>    # Conflicts:
>    #	src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/stylesheet.css
>  - JDK-8263468: Fix tests
>  - JDK-8263468: Update to latest CSR
>  - ... and 6 more: https://git.openjdk.java.net/jdk/compare/3396b69f...3b13ae32

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/NewAPIListWriter.java line 49:

> 47: /**
> 48:  * Generate File to list all the new API elements with the
> 49:  * appropriate links.

(minor) not standard form of comment, but it's "only" an internal class, so could be fixed up later

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/NewAPIListWriter.java line 72:

> 70:     /**
> 71:      * Get list of all the new elements.
> 72:      * Then instantiate NewAPIListWriter and generate File.

Comment. Looks like it may have been copied from elsewhere, I guess

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java line 726:

> 724:      */
> 725:     deprecatedInReleasePage,
> 726: 

Note to self ... affects new "Output Generated ...." document

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocPaths.java line 145:

> 143:     public static final DocPath PACKAGE_USE = DocPath.create("package-use.html");
> 144: 
> 145:     /** The name of the fie for preview elements. */

typo: "fie"

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocPaths.java line 148:

> 146:     public static final DocPath PREVIEW_LIST = DocPath.create("preview-list.html");
> 147: 
> 148:     /** The name of the fie for new elements. */

typo "fie"

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

> 1524:     }
> 1525: 
> 1526:     // Returns the Deprecated annotation element value of the given element, or null.

Use `/**...*/`

test/langtools/jdk/javadoc/doclet/testNewApiList/mdl/module-info.java line 30:

> 28: module mdl {
> 29:     exports pkg;
> 30: }

final newline

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

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


More information about the javadoc-dev mailing list