This is an automated email from the ASF dual-hosted git repository. michaelo pushed a commit to branch doxia-2.0.0 in repository https://gitbox.apache.org/repos/asf/maven-jxr.git
commit 05ef78ba0a2df336074e4d09903b56fef75490be Author: Michael Osipov <micha...@apache.org> AuthorDate: Sun Nov 12 23:40:40 2023 +0100 Dynamically calculate javadocDir/testJavadocDir @kriegaex --- .../main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java | 6 +++--- .../src/main/java/org/apache/maven/plugin/jxr/JxrReport.java | 6 ++++-- .../src/main/java/org/apache/maven/plugin/jxr/JxrTestReport.java | 6 ++++-- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java index 1c591f4..d6d2e02 100644 --- a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java +++ b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java @@ -238,7 +238,7 @@ public abstract class AbstractJxrReport extends AbstractMavenReport { } /** - * Returns the bottom text to be displayed at the lower part of the generated JXR reports. + * Returns the bottom text to be displayed at the lower part of the generated JXR report. */ private String getBottomText() { int currentYear = Calendar.getInstance().get(Calendar.YEAR); @@ -523,10 +523,10 @@ public abstract class AbstractJxrReport extends AbstractMavenReport { } /** - * Abstract method that returns the plugin report output directory where the generated JXR reports will be put + * Abstract method that returns the plugin report output directory where the generated JXR report will be put * beneath {@link #getReportOutputDirectory()}. * - * @return a String that contains the target directory name + * @return a String that contains the target directory */ protected abstract String getPluginReportOutputDirectory(); diff --git a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrReport.java b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrReport.java index b890aa9..af03991 100644 --- a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrReport.java +++ b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrReport.java @@ -54,8 +54,10 @@ public class JxrReport extends AbstractJxrReport { /** * Directory where Javadoc is generated for this project. + * <br> + * <strong>Default</strong>: {@link #getReportOutputDirectory()} + {@code /apidocs} */ - @Parameter(defaultValue = "${project.reporting.outputDirectory}/apidocs") + @Parameter private File javadocDir; @Override @@ -121,6 +123,6 @@ public class JxrReport extends AbstractJxrReport { @Override protected File getJavadocDir() { - return javadocDir; + return javadocDir != null ? javadocDir : new File(getReportOutputDirectory(), "apidocs"); } } diff --git a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrTestReport.java b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrTestReport.java index 546e3b3..bcc26cd 100644 --- a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrTestReport.java +++ b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrTestReport.java @@ -47,8 +47,10 @@ public class JxrTestReport extends AbstractJxrReport { /** * Directory where Test Javadoc is generated for this project. + * <br> + * <strong>Default</strong>: {@link #getReportOutputDirectory()} + {@code /testapidocs} */ - @Parameter(defaultValue = "${project.reporting.outputDirectory}/testapidocs") + @Parameter private File testJavadocDir; @Override @@ -103,6 +105,6 @@ public class JxrTestReport extends AbstractJxrReport { @Override protected File getJavadocDir() { - return testJavadocDir; + return testJavadocDir != null ? testJavadocDir : new File(getReportOutputDirectory(), "testapidocs"); } }