diff --git a/maven-jxr-plugin/src/it/JXR-100_parameterlink/verify.groovy b/maven-jxr-plugin/src/it/JXR-100_parameterlink/verify.groovy index e9591331..da990b9e 100644 --- a/maven-jxr-plugin/src/it/JXR-100_parameterlink/verify.groovy +++ b/maven-jxr-plugin/src/it/JXR-100_parameterlink/verify.groovy @@ -16,6 +16,8 @@ * specific language governing permissions and limitations * under the License. */ -assert new File( basedir, 'target/site/xref/com/mycompany/app/Foo.html' ).exists() +File file = new File( basedir, 'target/site/xref/com/mycompany/app/Foo.html' ); -assert 4 == new File( basedir, '/target/site/xref/com/mycompany/app/Foo.html' ).text.count( 'App' ) +assert file.exists() + +assert 4 == file.text.count( 'App' ) 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 cef5bb68..c4e395a6 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 @@ -194,23 +194,23 @@ && hasSources(currentFile)) { } /** - * Creates the Xref for the Java files found in the given source directory and puts them in the given destination + * Creates the Xref for the Java files found in the given source directory and puts them in the given output * directory. * * @param locale The user locale to use for the Xref generation - * @param destinationDirectory The output directory + * @param outputDirectory The output directory * @param sourceDirs The source directories * @throws java.io.IOException * @throws org.apache.maven.jxr.JxrException */ - private void createXref(Locale locale, String destinationDirectory, List sourceDirs) + private void createXref(Locale locale, String outputDirectory, List sourceDirs) throws IOException, JxrException { FileManager fileManager = new FileManager(); PackageManager packageManager = new PackageManager(fileManager); JavaCodeTransform codeTransform = new JavaCodeTransform(packageManager, fileManager); JXR jxr = new JXR(packageManager, codeTransform); - jxr.setDest(Paths.get(destinationDirectory)); + jxr.setDest(Paths.get(outputDirectory)); jxr.setInputEncoding(getInputEncoding()); jxr.setLocale(locale); jxr.setOutputEncoding(getOutputEncoding()); @@ -234,7 +234,7 @@ private void createXref(Locale locale, String destinationDirectory, List } // and finally copy the stylesheet - copyRequiredResources(destinationDirectory); + copyRequiredResources(outputDirectory); } /** @@ -285,28 +285,28 @@ private String getBottomText() { } /** - * Copy some required resources (like the stylesheet) to the given directory + * Copy some required resources (like the stylesheet) to the given target directory * - * @param dir the directory to copy the resources to + * @param targetDirectory the directory to copy the resources to */ - private void copyRequiredResources(String dir) { + private void copyRequiredResources(String targetDirectory) { if (stylesheet != null && !stylesheet.isEmpty()) { File stylesheetFile = new File(stylesheet); - File destStylesheetFile = new File(dir, "stylesheet.css"); + File targetStylesheetFile = new File(targetDirectory, "stylesheet.css"); try { if (stylesheetFile.isAbsolute()) { - FileUtils.copyFile(stylesheetFile, destStylesheetFile); + FileUtils.copyFile(stylesheetFile, targetStylesheetFile); } else { URL stylesheetUrl = this.getClass().getClassLoader().getResource(stylesheet); - FileUtils.copyURLToFile(stylesheetUrl, destStylesheetFile); + FileUtils.copyURLToFile(stylesheetUrl, targetStylesheetFile); } } catch (IOException e) { getLog().warn("An error occured while copying the stylesheet to the target directory", e); } } else { if (javadocTemplatesVersion.isAtLeast("1.8")) { - copyResources(dir, "jdk8/", "stylesheet.css"); + copyResources(targetDirectory, "jdk8/", "stylesheet.css"); } else if (javadocTemplatesVersion.isAtLeast("1.7")) { String[] jdk7Resources = { "stylesheet.css", @@ -315,14 +315,14 @@ private void copyRequiredResources(String dir) { "resources/titlebar.gif", "resources/titlebar_end.gif" }; - copyResources(dir, "jdk7/", jdk7Resources); + copyResources(targetDirectory, "jdk7/", jdk7Resources); } else if (javadocTemplatesVersion.isAtLeast("1.6")) { - copyResources(dir, "jdk6/", "stylesheet.css"); + copyResources(targetDirectory, "jdk6/", "stylesheet.css"); } else if (javadocTemplatesVersion.isAtLeast("1.4")) { - copyResources(dir, "jdk4/", "stylesheet.css"); + copyResources(targetDirectory, "jdk4/", "stylesheet.css"); } else { // Fallback to the original stylesheet - copyResources(dir, "", "stylesheet.css"); + copyResources(targetDirectory, "", "stylesheet.css"); } } } @@ -330,16 +330,16 @@ private void copyRequiredResources(String dir) { /** * Copy styles and related resources to the given directory * - * @param dir the directory to copy the resources to + * @param targetDirectory the target directory to copy the resources to * @param sourceDirectory resources subdirectory to copy from * @param files names of files to copy */ - private void copyResources(String dir, String sourceDirectory, String... files) { + private void copyResources(String targetDirectory, String sourceDirectory, String... files) { try { for (String file : files) { URL resourceUrl = this.getClass().getClassLoader().getResource(sourceDirectory + file); - File destResourceFile = new File(dir, file); - FileUtils.copyURLToFile(resourceUrl, destResourceFile); + File targetResourceFile = new File(targetDirectory, file); + FileUtils.copyURLToFile(resourceUrl, targetResourceFile); } } catch (IOException e) { getLog().warn("An error occured while copying the resource to the target directory", e); @@ -402,7 +402,7 @@ protected void executeReport(Locale locale) throws MavenReportException { setJavadocTemplatesVersion(); try { - createXref(locale, getDestinationDirectory(), sourceDirs); + createXref(locale, getPluginReportOutputDirectory(), sourceDirs); } catch (JxrException | IOException e) { throw new MavenReportException("Error while generating the HTML source code of the project.", e); } @@ -532,11 +532,12 @@ private Path getJavadocLocation() throws IOException { } /** - * Abstract method that returns the target directory where the generated JXR reports will be put. + * Abstract method that returns the plugin report output directory where the generated JXR reports will be put + * beneath {@link #getReportOutputDirectory()}. * * @return a String that contains the target directory name */ - protected abstract String getDestinationDirectory(); + protected abstract String getPluginReportOutputDirectory(); /** * Abstract method that returns the specified source directories that will be included in the JXR report generation. 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 725e14d0..b890aa9c 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 @@ -52,12 +52,6 @@ public class JxrReport extends AbstractJxrReport { @Parameter private String sourcePath; - /** - * Directory where the Xref files will be copied to. - */ - @Parameter(defaultValue = "${project.reporting.outputDirectory}/xref") - private String destDir; - /** * Directory where Javadoc is generated for this project. */ @@ -65,8 +59,8 @@ public class JxrReport extends AbstractJxrReport { private File javadocDir; @Override - protected String getDestinationDirectory() { - return destDir; + protected String getPluginReportOutputDirectory() { + return getReportOutputDirectory().getAbsolutePath() + "/xref"; } @Override @@ -129,14 +123,4 @@ public String getOutputName() { protected File getJavadocDir() { return javadocDir; } - - @Override - public void setReportOutputDirectory(File reportOutputDirectory) { - if ((reportOutputDirectory != null) - && (!reportOutputDirectory.getAbsolutePath().endsWith("xref"))) { - this.destDir = new File(reportOutputDirectory, "xref").getAbsolutePath(); - } else { - this.destDir = reportOutputDirectory.getAbsolutePath(); - } - } } 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 c7f43bb1..cdcbbdf7 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 @@ -45,12 +45,6 @@ public class JxrTestReport extends AbstractJxrReport { @Parameter(defaultValue = "${project.testCompileSourceRoots}", required = true, readonly = true) private List sourceDirs; - /** - * Directory where the Xref files will be copied to. - */ - @Parameter(defaultValue = "${project.reporting.outputDirectory}/xref-test") - private String destDir; - /** * Directory where Test Javadoc is generated for this project. */ @@ -88,8 +82,8 @@ protected List getSourceRoots(MavenProject project) { } @Override - protected String getDestinationDirectory() { - return destDir; + protected String getPluginReportOutputDirectory() { + return getReportOutputDirectory().getAbsolutePath() + "/xref-test"; } @Override @@ -111,14 +105,4 @@ public String getOutputName() { protected File getJavadocDir() { return testJavadocDir; } - - @Override - public void setReportOutputDirectory(File reportOutputDirectory) { - if ((reportOutputDirectory != null) - && (!reportOutputDirectory.getAbsolutePath().endsWith("xref-test"))) { - this.destDir = new File(reportOutputDirectory, "xref-test").getAbsolutePath(); - } else { - this.destDir = reportOutputDirectory.getAbsolutePath(); - } - } } diff --git a/maven-jxr-plugin/src/test/resources/unit/aggregate-test/aggregate-test-plugin-config.xml b/maven-jxr-plugin/src/test/resources/unit/aggregate-test/aggregate-test-plugin-config.xml index 347cf60a..73c0ab46 100644 --- a/maven-jxr-plugin/src/test/resources/unit/aggregate-test/aggregate-test-plugin-config.xml +++ b/maven-jxr-plugin/src/test/resources/unit/aggregate-test/aggregate-test-plugin-config.xml @@ -41,7 +41,6 @@ under the License. ${basedir}/src/test/resources/unit/aggregate-test/submodule1 ${basedir}/src/test/resources/unit/aggregate-test/submodule2 - ${basedir}/target/test/unit/aggregate-test/target/site/xref ${basedir}/target/test/unit/aggregate-test/target/site/apidocs false Copyright 2006 Apache Foundation diff --git a/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config-4.xml b/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config-4.xml index 124f7aab..410f864f 100644 --- a/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config-4.xml +++ b/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config-4.xml @@ -39,7 +39,6 @@ under the License. ${basedir}/src/test/resources/unit/default-configuration - ${basedir}/target/test/unit/default-configuration/target/site/4/xref ${basedir}/target/test/unit/default-configuration/target/site/4/apidocs true Copyright 2006 Apache Foundation diff --git a/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config-6.xml b/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config-6.xml index 5f0edb21..5d0184db 100644 --- a/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config-6.xml +++ b/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config-6.xml @@ -39,7 +39,6 @@ under the License. ${basedir}/src/test/resources/unit/default-configuration - ${basedir}/target/test/unit/default-configuration/target/site/6/xref ${basedir}/target/test/unit/default-configuration/target/site/6/apidocs true Copyright 2006 Apache Foundation diff --git a/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config-7.xml b/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config-7.xml index db16d9de..8620129b 100644 --- a/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config-7.xml +++ b/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config-7.xml @@ -39,7 +39,6 @@ under the License. ${basedir}/src/test/resources/unit/default-configuration - ${basedir}/target/test/unit/default-configuration/target/site/7/xref ${basedir}/target/test/unit/default-configuration/target/site/7/apidocs true Copyright 2006 Apache Foundation diff --git a/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config-8.xml b/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config-8.xml index 8be96ace..486776a7 100644 --- a/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config-8.xml +++ b/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config-8.xml @@ -39,7 +39,6 @@ under the License. ${basedir}/src/test/resources/unit/default-configuration - ${basedir}/target/test/unit/default-configuration/target/site/8/xref ${basedir}/target/test/unit/default-configuration/target/site/8/apidocs true Copyright 2006 Apache Foundation diff --git a/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config.xml b/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config.xml index 6841a758..a457dce8 100644 --- a/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config.xml +++ b/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config.xml @@ -39,7 +39,6 @@ under the License. ${basedir}/src/test/resources/unit/default-configuration - ${basedir}/target/test/unit/default-configuration/target/site/xref ${basedir}/target/test/unit/default-configuration/target/site/apidocs true Copyright 2006 Apache Foundation diff --git a/maven-jxr-plugin/src/test/resources/unit/default-configuration/exception-test-plugin-config.xml b/maven-jxr-plugin/src/test/resources/unit/default-configuration/exception-test-plugin-config.xml index 1ac1e930..06039de9 100644 --- a/maven-jxr-plugin/src/test/resources/unit/default-configuration/exception-test-plugin-config.xml +++ b/maven-jxr-plugin/src/test/resources/unit/default-configuration/exception-test-plugin-config.xml @@ -40,7 +40,6 @@ under the License. ${basedir}/src/test/resources/unit/default-configuration - ${basedir}/target/test/unit/default-configuration/target/site/xref ${basedir}/target/test/unit/default-configuration/target/site/apidocs true Copyright 2006 Apache Foundation diff --git a/maven-jxr-plugin/src/test/resources/unit/exclude-configuration/exclude-configuration-plugin-config.xml b/maven-jxr-plugin/src/test/resources/unit/exclude-configuration/exclude-configuration-plugin-config.xml index cc61d9f2..ff9bef70 100644 --- a/maven-jxr-plugin/src/test/resources/unit/exclude-configuration/exclude-configuration-plugin-config.xml +++ b/maven-jxr-plugin/src/test/resources/unit/exclude-configuration/exclude-configuration-plugin-config.xml @@ -40,7 +40,6 @@ under the License. ${basedir}/src/test/resources/unit/exclude-configuration - ${basedir}/target/test/unit/exclude-configuration/target/site/xref ${basedir}/target/test/unit/exclude-configuration/target/site/apidocs true Copyright 2006 Apache Foundation diff --git a/maven-jxr-plugin/src/test/resources/unit/include-configuration/include-configuration-plugin-config.xml b/maven-jxr-plugin/src/test/resources/unit/include-configuration/include-configuration-plugin-config.xml index 580c19cc..2cda9596 100644 --- a/maven-jxr-plugin/src/test/resources/unit/include-configuration/include-configuration-plugin-config.xml +++ b/maven-jxr-plugin/src/test/resources/unit/include-configuration/include-configuration-plugin-config.xml @@ -40,7 +40,6 @@ under the License. ${basedir}/src/test/resources/unit/include-configuration - ${basedir}/target/test/unit/include-configuration/target/site/xref ${basedir}/target/test/unit/include-configuration/target/site/apidocs true Copyright 2006 Apache Foundation diff --git a/maven-jxr-plugin/src/test/resources/unit/nojavadocdir-test/nojavadocdir-test-plugin-config.xml b/maven-jxr-plugin/src/test/resources/unit/nojavadocdir-test/nojavadocdir-test-plugin-config.xml index 351f7aa4..fed568a8 100644 --- a/maven-jxr-plugin/src/test/resources/unit/nojavadocdir-test/nojavadocdir-test-plugin-config.xml +++ b/maven-jxr-plugin/src/test/resources/unit/nojavadocdir-test/nojavadocdir-test-plugin-config.xml @@ -40,7 +40,6 @@ under the License. ${basedir}/src/test/resources/unit/nojavadocdir-test - ${basedir}/target/test/unit/nojavadocdir-test/target/site/xref ${basedir}/target/test/unit/nojavadocdir-test/target/site/apidocs true Copyright 2006 Apache Foundation diff --git a/maven-jxr-plugin/src/test/resources/unit/nojavadoclink-configuration/nojavadoclink-configuration-plugin-config.xml b/maven-jxr-plugin/src/test/resources/unit/nojavadoclink-configuration/nojavadoclink-configuration-plugin-config.xml index 6fae9b8c..b66627d2 100644 --- a/maven-jxr-plugin/src/test/resources/unit/nojavadoclink-configuration/nojavadoclink-configuration-plugin-config.xml +++ b/maven-jxr-plugin/src/test/resources/unit/nojavadoclink-configuration/nojavadoclink-configuration-plugin-config.xml @@ -40,7 +40,6 @@ under the License. ${basedir}/src/test/resources/unit/nojavadoclink-configuration - ${basedir}/target/test/unit/nojavadoclink-configuration/target/site/xref ${basedir}/target/test/unit/nojavadoclink-configuration/target/site/apidocs false Copyright 2006 Apache Foundation diff --git a/maven-jxr-plugin/src/test/resources/unit/testsourcedir-test/testsourcedir-test-plugin-config.xml b/maven-jxr-plugin/src/test/resources/unit/testsourcedir-test/testsourcedir-test-plugin-config.xml index 6f08c17d..75834997 100644 --- a/maven-jxr-plugin/src/test/resources/unit/testsourcedir-test/testsourcedir-test-plugin-config.xml +++ b/maven-jxr-plugin/src/test/resources/unit/testsourcedir-test/testsourcedir-test-plugin-config.xml @@ -40,7 +40,6 @@ under the License. ${basedir}/src/test/resources/unit/testsourcedir-test/src/test/java - ${basedir}/target/test/unit/testsourcedir-test/target/site/xref-test Copyright 2006 Apache Foundation 1.4 stylesheet.css