#1088365 wishlist: automatically link against default-jdk-doc

#1088365#5
Date:
2024-11-27 13:34:42 UTC
From:
To:
Dear Maintainers,

It would be nice to have the maven-javadoc-plugin automatically link against
default-jdk-doc when building Debian packages and not configured otherwise.

Currently achieving that requires patching upstream build files, e.g.:
--- a/pom.xml
+++ b/pom.xml
@@ -299,6 +299,10 @@
           <charset>UTF-8</charset>
           <docencoding>UTF-8</docencoding>
           <encoding>UTF-8</encoding>
+          <links>
+            <!-- Debian: link to default-jdk-doc -->
+            <link>file:///usr/share/doc/default-jre-headless/api/</link>
+          </links>
         </configuration>
         <executions>
           <execution>

Additionally it would be even nicer if it linked the generated docs against the
jquery-ui packaged in Debian. Achieving that currently requires adding some
recipes in debian/rules, e.g.:

override_dh_auto_build:
        dh_auto_build
# Replace jquery copies with links and remove versioning
        find target/apidocs/apidocs/script-dir/ -name 'jquery*' -delete
        ln -s /usr/share/javascript/jquery-ui/themes/base/jquery-ui.min.css \
                target/apidocs/apidocs/script-dir/jquery-ui.min.css
        ln -s /usr/share/javascript/jquery-ui/jquery-ui.min.js \
                target/apidocs/apidocs/script-dir/jquery-ui.min.js
        ln -s /usr/share/javascript/jquery/jquery.min.js \
                target/apidocs/apidocs/script-dir/jquery.min.js
        find target/apidocs -name '*.html' -print0 | \
                xargs -r0 sed -i -e 's/jquery-[0-9.]\+\.min\.js/jquery.min.js/'
# Licenses are provided with the jquery packages
        $(RM) target/apidocs/apidocs/legal/jquery.md \
                target/apidocs/apidocs/legal/jqueryUI.md

Best regards,