[jira] Closed: (MJAVADOC-95) Confusing and configuration options

["Vincent Siveton (JIRA)" <ji...@codehaus.org>]

     [ http://jira.codehaus.org/browse/MJAVADOC-95?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Vincent Siveton closed MJAVADOC-95.
-----------------------------------

         Assignee: Vincent Siveton
       Resolution: Fixed
    Fix Version/s: 2.3

It is only a Seperation of Concerns (Soc)

reportOutputDirectory implies that you configure a <reporting/> section in your pom.
outputDirectory is more used by the <plugin/> configuration in the <build/> section.

Default values are :
reportOutputDirectory = ${project.reporting.outputDirectory}/apidocs
outputDirectory = ${project.build.directory}/apidocs
jarOutputDirectory = ${project.build.directory}


> Confusing <reportOutputDirectory> and <outputDirectory> configuration options
> -----------------------------------------------------------------------------
>
>                 Key: MJAVADOC-95
>                 URL: http://jira.codehaus.org/browse/MJAVADOC-95
>             Project: Maven 2.x Javadoc Plugin
>          Issue Type: Wish
>    Affects Versions: 2.1
>            Reporter: Dmitry Katsubo
>            Assignee: Vincent Siveton
>            Priority: Minor
>             Fix For: 2.3
>
>
> 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|http://maven.apache.org/plugins/maven-eclipse-plugin/reactor.html] configuration example below. The aim is to generate javadoc HTML and jar as follows:
> {noformat} 
> 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
>  |
> ...
> {noformat} 
> I am using the following configuration in {{my-project/pom.xml}}:
> {code: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>
> {code}

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira