maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Gili (JIRA)" <>
Subject [jira] [Commented] (MJAVADOC-560) Clarify outputDirectory, reportOutputDirectory in javadoc:javadoc documentation
Date Sat, 09 Feb 2019 19:42:00 GMT


Gili commented on MJAVADOC-560:

{quote}The directories have different purposes and both and required by the plugin (reportOutputDirectory
by all goals, outputDirectory only by packaging goals).
I'm a little confused by this given that {{javadoc:javadoc}} does not generate a JAR file
yet [] mentions "outputDirectory".
{quote}The outputDirectory is used for the jar, the reportOutputDirectory is used for the
generated javadocs.
So, anywhere we have "outputDirectory" I would change the description to "Specifies the destination
directory where the javadoc JAR file is written".

> Clarify outputDirectory, reportOutputDirectory in javadoc:javadoc documentation
> -------------------------------------------------------------------------------
>                 Key: MJAVADOC-560
>                 URL:
>             Project: Maven Javadoc Plugin
>          Issue Type: Bug
>          Components: javadoc
>    Affects Versions: 3.1.0
>            Reporter: Gili
>            Priority: Major
> Looking at the documentation for javadoc:javadoc at [] 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 *${}/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 [] 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 []

This message was sent by Atlassian JIRA

View raw message