RFR: 8343752: The javadoc should contain a note about usages of requires transitive java.base;

Adam Sotona asotona at openjdk.org
Thu Nov 7 14:05:44 UTC 2024


On Thu, 7 Nov 2024 12:03:18 GMT, Jan Lahoda <jlahoda at openjdk.org> wrote:

> When https://github.com/openjdk/jdk/pull/21431 is integrated, there will be a new preview language feature: `requires transitive java.base;`. It would be good to show a warning box in the javadoc about the use of the feature. This PR is attempting to add such a warning box.
> 
> Given it is likely this feature will either graduate or be dropped in the span of a few releases, I tried to make the code (relatively) easy to remove: it should be enough to delete the `if (javaBase != null && indirectPackages.keySet().contains(javaBase)) {` and the then section, keeping the else section + some slight cleanup.
> 
> The new javadoc can be seen here:
> https://cr.openjdk.org/~jlahoda/8343752/updated/api/java.se/module-summary.html#preview-requires-transitive-java.base

Looks good to me.

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

Marked as reviewed by asotona (Reviewer).

PR Review: https://git.openjdk.org/jdk/pull/21949#pullrequestreview-2421073380


More information about the javadoc-dev mailing list