Maven 2.x Javadoc Plugin

Aggregate report ignores sourcepath customization of subprojects

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Cannot Reproduce
  • Affects Version/s: 2.3
  • Fix Version/s: None
  • Component/s: None
  • Labels:
    None
  • Environment:
    Maven 2.0.8, Java 1.5, Windows
  • Testcase included:
    yes
  • Number of attachments :
    0

Description

When using aggregate javadoc reporting with one of subproject being customized to include java sources from alternative directories, only original source directories are passed to javadoc executable.

For instance, I use POJO's generated by Hibernate3 from HBM files which are documented. The generated files are placed into ${basedir}/target/hibernate3/generated-sources/ directory. My subproject's POM contains the following definition:

<reporting>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>2.2</version>
                <configuration>
                  <sourcepath>$\{basedir\}/src/main/java;$\{basedir]}/target/hibernate3/generated-sources</sourcepath>
                </configuration>
            </plugin>
        </plugins>
    </reporting>

and it works correctly if running mvn site on subproject level. If run from the parent project, as I traced, the custom directory does not passed to the javadoc tool.

Issue Links

This issue relates to:
MJAVADOC-181 Javadoc report not generated for multi-module project if run from parent level. Major Closed
This issue is related to:
MJAVADOC-168 Regression: 2.4-SNAPSHOT does not generate docs for generates sources if run outside a build Major Closed

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Vincent Siveton added a comment -

I cant reproduce it with 2.4 and 2.5-SNAPSHOT. So, try with these versions and feel free to reopen it if the pb is still there (Think to including a test case...)
Thanks.

Show
Vincent Siveton added a comment - I cant reproduce it with 2.4 and 2.5-SNAPSHOT. So, try with these versions and feel free to reopen it if the pb is still there (Think to including a test case...) Thanks.
Hide
Permalink
Fol De Rol added a comment -

Still reproduced in 2.4

Show
Fol De Rol added a comment - Still reproduced in 2.4
Hide
Permalink
Fol De Rol added a comment -

A test case:

fragment of the parent POM:

<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.4</version>
<configuration>
<aggregate>true</aggregate>
</configuration>
</plugin>
</plugins>
</reporting>

fragment of the sub-module POM:

<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.4</version>
<configuration>
<sourcepath>${basedir}/src/main/java;${basedir}/target/hibernate3/generated-sources</sourcepath>
</configuration>
</plugin>
</plugins>
</reporting>

not any class from target/hibernate3/generated-sources is aggregated into the complete javadoc.

Show
Fol De Rol added a comment - A test case: fragment of the parent POM: <reporting> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>2.4</version> <configuration> <aggregate>true</aggregate> </configuration> </plugin> </plugins> </reporting> fragment of the sub-module POM: <reporting> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>2.4</version> <configuration> <sourcepath>${basedir}/src/main/java;${basedir}/target/hibernate3/generated-sources</sourcepath> </configuration> </plugin> </plugins> </reporting> not any class from target/hibernate3/generated-sources is aggregated into the complete javadoc.
Hide
Permalink
Vincent Siveton added a comment -

Should be fixed in r661899. Could you confirm that you used this revision?

Show
Vincent Siveton added a comment - Should be fixed in r661899. Could you confirm that you used this revision?
Hide
Permalink
Vincent Siveton added a comment -

Without any feedbacks, we can't help you.

Show
Vincent Siveton added a comment - Without any feedbacks, we can't help you.
Hide
Permalink
Fol De Rol added a comment -

I confirm the issue is fixed in 2.5.

Show
Fol De Rol added a comment - I confirm the issue is fixed in 2.5.

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved:
Atlassian JIRA (v4.4.3#663-r165197) | Report a problem
Powered by a free Atlassian JIRA open source license for Codehaus. Try JIRA - bug tracking software for your team.