Gili created MJAVADOC-560:
-----------------------------
Summary: Clarify outputDirectory, reportOutputDirectory in
javadoc:javadoc documentation
Key: MJAVADOC-560
URL: https://issues.apache.org/jira/browse/MJAVADOC-560
Project: Maven Javadoc Plugin
Issue Type: Bug
Components: javadoc
Affects Versions: 3.1.0
Reporter: Gili
Looking at the documentation for javadoc:javadoc at
[https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html] I see
three problems:
# The documentation lists both *outputDirectory* and *reportOutputDirectory*
parameters, having the same description. It's not clear what each one is used
for or what happens if one property is changed without the other.
# The default value of *outputDirectory* is listed as
*${project.build.directory}/apidocs* but the value that is actually used is
*${project.reporting.outputDirectory}/apidocs* (the value of
*reportOutputDirectory*).
# It was extremely difficult to find any documentation on
*${project.reporting.outputDirectory}***, such as what its default value is. I
eventually found [https://maven.apache.org/pom.html#Reporting] but Google does
not link directly to this page/section because it doesn't contain an explicit
reference to *${project.reporting}*.
Suggested fix(es):
# Drop one of the two parameters, ideally *reportOutputDirectory*, to avoid
confusion.
# Update the documentation so it lists the correct default value for
*outputDirectory*.
# Link directly from mention of *${project.reporting.outputDirectory}* to
[https://maven.apache.org/pom.html#Reporting]
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
