Document behaviour around 'destDir' naming

[ascopes]

It appears the current codebase is set up to explicitly ignore the 'destDir' parameter if it does not explicitly end with the string 'xref'. This is currently unclear in the documentation and is only able to be discovered upon reading the source code itself.

This behaviour can be seen at

maven-jxr/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrReport.java

Lines 133 to 142 in bbab747

	@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();
	}
	}
	}

.

• I hereby declare this contribution to be licenced under the Apache License Version 2.0, January 2004

[michael-o]

Thank you for your PR, that parameter along with other inconsistencies have already been cleaned up/removed in #64. I hope to merge that this summer.