[OpenJDK 2D-Dev] [14] RFR JDK-8231144: Wrap contents of plain HTML files into contentContainer

Philip Race philip.race at oracle.com
Tue Sep 24 19:12:18 UTC 2019


All looks good to me.

-phil

On 9/24/19, 11:37 AM, Alexey Ivanov wrote:
> Hello,
>
> Please review the following simple fix for JDK 14:
>
> bug: https://bugs.openjdk.java.net/browse/JDK-8231144
> webrev: http://cr.openjdk.java.net/~aivanov/8231144/webrev.00/
> docs: 
> http://cr.openjdk.java.net/~aivanov/8231144/docs.00/api/java.desktop/module-summary.html
>
> Plain HTML documentation files have no left margin after processing by 
> javadoc. It does not look good. For example, see the following files 
> in JDK 13 API reference:
> https://docs.oracle.com/en/java/javase/13/docs/api/java.desktop/javax/imageio/metadata/doc-files/gif_metadata.html 
>
> https://docs.oracle.com/en/java/javase/13/docs/api/java.desktop/java/awt/doc-files/Modality.html 
>
>
> This simple fix wraps the entire content of the file, between <main> 
> and </main>, into <div class="contentContainer"> and </div> which 
> provide the margins for class descriptions. Thus, these HTML 
> documentation files look consistently, they're also easier to read:
> http://cr.openjdk.java.net/~aivanov/8231144/docs.00/api/java.desktop/javax/imageio/metadata/doc-files/gif_metadata.html 
>
> http://cr.openjdk.java.net/~aivanov/8231144/docs.00/api/java.desktop/java/awt/doc-files/Modality.html 
>
>
>
> I attached the screenshots of gif_metadata.html displayed in src, api 
> reference, and api reference with the fix applied.
>


More information about the 2d-dev mailing list