[MJAVADOC-95] Confusing <reportOutputDirectory> and <outputDirectory> configuration options

• Type: Wish
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 2.1
• Fix Version/s: 2.3
• Assignee: Siveton Vincent
• Reporter: Dmitry Katsubo
• Created: 13/Oct/06 04:09
• Updated: 28/Apr/08 18:19
• Resolved: 13/May/07 09:31

Description

There are two confoguration options, which are a bit confusing:

• <reportOutputDirectory> used by mvn javadoc:javadoc
• <outputDirectory> used by mvn javadoc:jar
  Can they get an equal meaning and usage? Please, concider the multiproject configuration example below. The aim is to generate javadoc HTML and jar as follows:

 
my-project
 +- docs
     +- javadoc
     |   +- my-lib-1.0
     |   |   +- index.html
     |   |   ...
     |   +- my-lib-api-1.0
     |   |   +- index.html
     |   |   ...
     |   +- my-lib-1.0-javadoc.jar
     |   +- my-lib-api-1.0-javadoc.jar
... 
my-lib
 +- src
 |   +- java
 +- target
 |
...
my-lib-api
 +- src
 |   +- java
 +- target
 |
...

I am using the following configuration in my-project/pom.xml:

<build>
  <plugins>
    <plugin>
      <inherited>true</inherited>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <configuration>
        <!-- Confusing: -->
        <reportOutputDirectory>../my-project/docs/javadoc/${project.artifactId}-${project.version}</reportOutputDirectory>
        <outputDirectory>../my-project/docs/javadoc/${project.artifactId}-${project.version}</outputDirectory>
        <jarOutputDirectory>../my-project/docs/javadoc</jarOutputDirectory>
        <source>1.5</source>
        <notimestamp>true</notimestamp>
        <linksourcetab>4</linksourcetab>
      </configuration>
    </plugin>
  </plugins>
</build>
<modules>
  <module>../my-lib</module>
  <module>../my-lib-api</module>
</modules>