RFR: 8352151: Fix display issues in javadoc-generated docs

Chen Liang liach at openjdk.org
Fri Mar 21 05:09:05 UTC 2025


On Mon, 17 Mar 2025 16:06:58 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

> Please review a patch to fix a number of display bugs in javadoc-generated documentation.
> 
>  -  Snippet copy button is transparent and can overlap with snippet content ([before][snippet-before], [after][snippet-after])
>  - After clicking on the second-to-last item in the sidebar, the last item is highlighted if the click triggers scrolling to the end of the page ([before][target-before], [after][target-after])
>  - No indentation on sidebar entries beyond the first two levels of hierarchy ([before][indent-before], [after][indent-after])
>  - (Minor) Add vertical margin to search page inputs so they look better when wrapped
> 
> [snippet-before]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/lang/invoke/MethodHandle.html#asSpreader(int,java.lang.Class,int)
> [snippet-after]: https://cr.openjdk.org/~hannesw/8352151/api.00/java.base/java/lang/invoke/MethodHandle.html#asSpreader(int,java.lang.Class,int)
> 
> [target-before]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/lang/Thread.Builder.html#start(java.lang.Runnable)
> [target-after]: https://cr.openjdk.org/~hannesw/8352151/api.00/java.base/java/lang/Thread.Builder.html#start(java.lang.Runnable)
> 
> [indent-before]: https://download.java.net/java/early_access/jdk25/docs/api/help-doc.html
> [indent-after]: https://cr.openjdk.org/~hannesw/8352151/api.00/help-doc.html
> 
> The sidebar highlighting script actually became simpler, which is great. The snippet copy button change is a bit more involved, because I had to change snippet layout to not overlay snippet content with the copy button, and make the button opaque. But the result is better than what we had before IMO. The other changes are simple one-liners.

The js part looks good. Not too sure about the CSS, @nizarbenalla might check too. The rendered effects look good.

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

Marked as reviewed by liach (Reviewer).

PR Review: https://git.openjdk.org/jdk/pull/24083#pullrequestreview-2704748162


More information about the javadoc-dev mailing list