[Git][java-team/maven-javadoc-plugin][master] Reverted the default output directory to ./target/apidocs

[Emmanuel Bourg (@ebourg)]

Emmanuel Bourg pushed to branch master at Debian Java Maintainers / maven-javadoc-plugin


Commits:
fc4f9775 by Emmanuel Bourg at 2024-10-28T19:36:31+01:00
Reverted the default output directory to ./target/apidocs

- - - - -


3 changed files:

- debian/changelog
- + debian/patches/output-directory.patch
- debian/patches/series


Changes:

=====================================
debian/changelog
=====================================
@@ -1,3 +1,10 @@
+maven-javadoc-plugin (3.10.1-2) unstable; urgency=medium
+
+  * Team upload.
+  * Reverted the default output directory to ./target/apidocs
+
+ -- Emmanuel Bourg <ebourg at apache.org>  Mon, 28 Oct 2024 19:24:53 +0100
+
 maven-javadoc-plugin (3.10.1-1) unstable; urgency=medium
 
   * Team upload.


=====================================
debian/patches/output-directory.patch
=====================================
@@ -0,0 +1,53 @@
+Description: Generate the javadoc by default in target/apidocs instead of target/reports/apidocs
+Author: Emmanuel Bourg <ebourg at apache.org>
+Forwarded: not-needed
+--- a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
++++ b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
+@@ -1246,15 +1246,14 @@
+     private OfflineLink[] offlineLinks;
+ 
+     /**
+-     * The shared output directory for the report where Javadoc saves the generated HTML files.
+-     * Note that this parameter is only evaluated if the goal is run directly from the command line.
+-     * If the goal is run indirectly as part of a site generation, the shared output directory configured in the
+-     * <a href="https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#outputDirectory">Maven Site Plugin</a>
+-     * is used instead.
+-     * @see org.apache.maven.reporting.AbstractMavenReport#outputDirectory
++     * Specifies the destination directory where javadoc saves the generated HTML files.
+      * @see <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet">Doclet option d</a>
+      */
+-    @Parameter(defaultValue = "${project.build.directory}/reports", required = true)
++    @Parameter(
++            property = "destDir",
++            alias = "destDir",
++            defaultValue = "${project.build.directory}/apidocs",
++            required = true)
+     protected File outputDirectory;
+ 
+     /**
+@@ -1735,7 +1734,7 @@
+      * @return a String that contains the target directory
+      */
+     protected String getPluginReportOutputDirectory() {
+-        return getOutputDirectory() + "/" + (isTest() ? "test" : "") + "apidocs";
++        return getOutputDirectory();
+     }
+ 
+     protected MavenProject getProject() {
+@@ -5926,8 +5925,15 @@
+         }
+ 
+         String url = cleanUrl(p.getUrl());
++        String destDir = "apidocs"; // see JavadocReport#destDir
++
++        final String pluginId = "org.apache.maven.plugins:maven-javadoc-plugin";
++        String destDirConfigured = getPluginParameter(p, pluginId, "destDir");
++        if (destDirConfigured != null) {
++            destDir = destDirConfigured;
++        }
+ 
+-        return url + "/apidocs";
++        return url + "/" + destDir;
+     }
+ 
+     /**


=====================================
debian/patches/series
=====================================
@@ -4,3 +4,4 @@ default-detectJavaApiLink-to-false.patch
 disable-doclint.patch
 auto-adjust-language-level.patch
 plexus-utils-compatibility.patch
+output-directory.patch



View it on GitLab: https://salsa.debian.org/java-team/maven-javadoc-plugin/-/commit/fc4f9775e7e7fddaf880be5cfc551338e5c1d29f

-- 
View it on GitLab: https://salsa.debian.org/java-team/maven-javadoc-plugin/-/commit/fc4f9775e7e7fddaf880be5cfc551338e5c1d29f
You're receiving this email because of your account on salsa.debian.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://alioth-lists.debian.net/pipermail/pkg-java-commits/attachments/20241028/fbed1a4a/attachment.htm>