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

[Hannes Wallnöfer]

On Fri, 8 Nov 2024 10:17:04 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
>
> Jan Lahoda has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains seven additional commits since the last revision:
> 
>  - Adding forgotten file.
>  - Merge branch 'JDK-8335989' into preview-javadoc-requires-transitive-java.base
>  - Better detection of requires transitive java.base; - fixes tests.
>  - Cleanup: avoid unnecessary bundle key.
>  - Adding a test, adjusting the message.
>  - Improving the UI, as suggested.
>  - Creating a separate javadoc section for the preview 'requires transitive java.base;' in the java.se module.

Changes look good, it's nice that you kept the code changes in a single blob.

>From an HTML point of view, if the purpose of the `<div>` elements in the preview message is just to cause a line break, it would be slightly simpler and more idiomatic to just append a `<br>` tag:

    line1<br>\
    line2<br>\
    ...

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

Marked as reviewed by hannesw (Reviewer).

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