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

[Hannes Wallnöfer]

On Fri, 8 Nov 2024 16:58:52 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 incrementally with one additional commit since the last revision:
> 
>   Using <br> instead of <div>, as suggested.

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModuleWriter.java line 605:

> 603:                     //add the preview box:
> 604:                     section.add(HtmlTree.DIV(HtmlTree.BR()));
> 605:                     section.add(HtmlTree.DIV(HtmlTree.BR()));

I just saw this in the generated HTML. Using `<br>` tags to add vertical space is ok, but there's no need to put them inside a `<div>` element. Adding only the `<br>` tags should have the same effect.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/21949#discussion_r1834811279