Bug#1088365: wishlist: automatically link against default-jdk-doc when building Debian packaged

[Julien Plissonneau Duquène]

Package: libmaven-javadoc-plugin-java
Version: 3.10.1-2
Severity: wishlist
X-Debbugs-Cc: sre4ever at free.fr

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,

--
Julien Plissonneau Duquène


-- System Information:
Debian Release: trixie/sid
  APT prefers trixie
  APT policy: (500, 'trixie'), (500, 'testing'), (20, 'unstable'), (10, 'experimental'), (5, 'stable')
Architecture: amd64 (x86_64)

Kernel: Linux 6.11.2-amd64 (SMP w/4 CPU threads; PREEMPT)
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8), LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled

Versions of packages libmaven-javadoc-plugin-java depends on:
ii  libatinject-jsr330-api-java            1.0+ds1-5
ii  libcommons-io-java                     2.17.0-1
ii  libcommons-lang3-java                  3.17.0-1
ii  libcommons-text-java                   1.12.0-1
ii  libdoxia-core-java                     2.0.0-1
ii  libdoxia-sitetools-java                2.0.0-1
ii  libhttpclient-java                     4.5.14-1
ii  libhttpcore-java                       4.4.16-1
ii  libmaven-archiver-java                 3.6.2-1
ii  libmaven-common-artifact-filters-java  3.4.0-1
ii  libmaven-invoker-java                  3.3.0-1
ii  libmaven-parent-java                   43-2
ii  libmaven-reporting-api-java            4.0.0-1
ii  libmaven-resolver-java                 1.6.3-1
ii  libmaven-shared-utils-java             3.4.2-1
ii  libplexus-archiver-java                4.6.1-1
ii  libplexus-interactivity-api-java       1.3-1
ii  libplexus-io-java                      3.3.1-2
ii  libplexus-languages-java               1.1.1-2
ii  libplexus-utils2-java                  3.4.2-1
ii  libplexus-xml-java                     3.0.1-2
ii  libqdox2-java                          2.0.3-1
ii  libwagon-provider-api-java             3.5.3-1

libmaven-javadoc-plugin-java recommends no packages.

libmaven-javadoc-plugin-java suggests no packages.

-- no debconf information