RFR [15] 8236823: Ensure that API documentation uses minified libraries

Jonathan Gibbons jonathan.gibbons at oracle.com
Fri May 29 15:07:38 UTC 2020


+1 for the changes in this patch, and +1 for following up with 
additional changes to improve this process.

-- Jon

On 5/28/20 7:08 AM, Pavel Rappo wrote:
> Hello,
>
> Please review the change for https://bugs.openjdk.java.net/browse/JDK-8236823
>
>    http://cr.openjdk.java.net/~prappo/8236823/webrev.00/
>
> This is the right time to fix this issue and perform an additional but related cleanup. The reason for this is the upcoming upgrade to jQuery 3.5.1, JBS-8245981. If applied this change will allow for a cleaner upgrade now and in the future.
>
> This patch:
>
> 1. Adds a missing minified version of jQuery, jquery-3.4.1.min.js
> 2. Switches JavaDoc to minified versions of the .js and .css files where possible
> 3. Reverts the change made in JDK-8243562 to jquery-ui.css and introduces an alternative solution to that problem. That solution allows for cleaner upgrades of jQuery UI in the future.
>
> ***
>
> There are three issues I particularly noticed while working on this, yet I'm not addressing them in this patch. Resolving those issues will improve maintainability in that area.
>
> 1. I don't understand why JDK-8222548 renamed "jquery.js" to "jquery-3.4.1.js". Unless necessary, things like this introduce unneeded churn to the codebase. It's much cleaner to change just the contents of a file rather than both the contents and the name as that name might be used in the codebase. So, I'm thinking of renaming jquery-x.y.z.v.js back to just jquery.v.js.
>
> 2. The particulars of jQuery and friends are spread across multiple places in the jdk.javadoc codebase. That needlessly complicates changes. To remediate that, JavaDoc could hide all the details such as file paths, versions, the order of .css overrides, etc. behind some sort of a "facade" object.
>
> 3. Do we need non-minified versions of the libraries?
>
> -Pavel
>


More information about the javadoc-dev mailing list