Issue Details (XML | Word | Printable)

Key: MJAVADOC-168
Type: Bug Bug
Status: Closed Closed
Resolution: Fixed
Priority: Major Major
Assignee: Vincent Siveton
Reporter: Benjamin Bentmann
Votes: 1
Watchers: 1
Operations

If you were logged in you would be able to see more operations.
Maven 2.x Javadoc Plugin

Regression: 2.4-SNAPSHOT does not generate docs for generates sources if run outside a build

Created: 18/Jan/08 09:04 AM   Updated: 02/Jan/09 05:18 AM   Resolved: 30/May/08 05:20 PM
Return to search
Component/s: None
Affects Version/s: 2.4
Fix Version/s: 2.5

Time Tracking:
Not Specified

File Attachments: 1. Zip Archive MJAVADOC-168.zip (1 kB)

Environment: Maven 2.0.8, JDK 1.5.0_12, WinXP
Issue Links:
Duplicate
 
Related


 Description  « Hide

The fix applied for MJAVADOC-145 causes the plugin to loose source roots that get created during the generate-sources build phase. I.e. if one runs

mvn org.apache.maven.plugins:maven-javadoc-plugin:2.3:javadoc

the plugin properly documents generated source code but running

mvn org.apache.maven.plugins:maven-javadoc-plugin:2.4-SNAPSHOT:javadoc

only documents the default source root "src/main/java".

Usually, I would expect to have the JavadocReport mojo @execute phase="generate-sources" and the TestJavadocReport mojo to have @execute phase="generate-test-sources" (although it's kind of ugly to have the compile phase being run in the later case).

In lack of these annotations, the plugin produces different output when run directly from the command line or indirectly as part of build.



Benjamin Bentmann made changes - 18/Jan/08 09:05 AM
Field Original Value New Value
Link This issue is related to MJAVADOC-145 [ MJAVADOC-145 ]
Benjamin Bentmann made changes - 18/Jan/08 09:05 AM
Link This issue is related to MJAVADOC-138 [ MJAVADOC-138 ]
Benjamin Bentmann added a comment - 18/Jan/08 09:26 AM

Here's a test project to play with. When invoking "mvn javadoc:javadoc" only the class "Main" makes it into the api docs. If you invoke "mvn compile" (where I added an execution of the javadoc plugin), you get both "Main" and "GeneratedClass".

If the @execute annotation really cannot be re-added due to MJAVADOC-145, there must at least be some doc/faq about this odd behavior. However, I currently do not believe that @execute was the real cause of this other issue. I would rather ask why the mojo has @phase generate-sources as annotation. The Javadoc Plugin does not really participate in the default build cycle, its usually part of the site lifecycle.


Benjamin Bentmann made changes - 18/Jan/08 09:26 AM
Attachment MJAVADOC-168.zip [ 31951 ]
Benjamin Bentmann added a comment - 18/Jan/08 09:33 AM

The TestJavadocReport mojo has @phase generate-test-sources which doesn't make much sense either. I bet the original committer meant @execute phase=generate-test-sources instead.


Vincent Siveton added a comment - 30/May/08 05:20 PM

fixed in r661899, snapshot deployed


Vincent Siveton made changes - 30/May/08 05:20 PM
Assignee Vincent Siveton [ siveton ]
Resolution Fixed [ 1 ]
Fix Version/s 2.5 [ 14120 ]
Status Open [ 1 ] Closed [ 6 ]
Vincent Siveton made changes - 30/May/08 05:20 PM
Link This issue is duplicated by MJAVADOC-186 [ MJAVADOC-186 ]
Vincent Siveton made changes - 30/May/08 05:25 PM
Link This issue relates to MJAVADOC-179 [ MJAVADOC-179 ]
Benjamin Bentmann made changes - 30/May/08 05:50 PM
Link This issue is duplicated by MJAVADOC-194 [ MJAVADOC-194 ]
Vincent Siveton made changes - 05/Jun/08 07:22 AM
Link This issue is duplicated by MJAVADOC-194 [ MJAVADOC-194 ]
Benjamin Bentmann made changes - 02/Jan/09 05:18 AM
Link This issue relates to MJAVADOC-194 [ MJAVADOC-194 ]