[ 
http://jira.codehaus.org/browse/MJAVADOC-138?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_109734
 ] 

Benjamin Bentmann commented on MJAVADOC-138:
--------------------------------------------

Well, why to depend on the compiled classes of the project anyway? Regarding 
the currently build project, you have something better than just bytecode, the 
sources! Unlike the class files, the sources carry documentation that javadoc 
can use to inherit documentation (e.g. for overriden methods). So, instead of
{code}-classpath '[SNIP]/target/classes;[SNIP]/target/tests-classes;...'{code}
I would rather aim at
{code}
-classpath '...'
-sourcepath '[SNIP]/src/main/java;[SNIP]/src/test/java;...'
{code}

However, just including the project main sources on the source path has an 
unwanted effect: One will likely get Javadoc for production classes if those 
happen to reside in the same package as some test class (a common scenario for 
organizing tests). This effect stems from the fact, that the plugin currently 
specifies which packages to document and javadoc cannot distinguish from main 
and test sources. But that is easily solved: Instead of listing up packages, 
the plugin simply needs to scan all test source directories for Java files and 
put those in an arg file.

> javadoc:test-javadoc failed if target/classes not already created
> -----------------------------------------------------------------
>
>                 Key: MJAVADOC-138
>                 URL: http://jira.codehaus.org/browse/MJAVADOC-138
>             Project: Maven 2.x Javadoc Plugin
>          Issue Type: Bug
>    Affects Versions: 2.3
>            Reporter: Vincent Siveton
>
> Using 
> {noformat}
> mvn clean javadoc:test-javadoc
> {noformat}
> it could produce unsuccessful build or warning (depending the javadoc version 
> used, i.e 1.4 vs 1.5)
> The options file contains:
> {noformat}
> -classpath '[SNIP]/target/classes;[SNIP]/target/tests-classes;...'
> {noformat}
> The explanation is that no target\classes was created before executing 
> test-javadoc

-- 
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

        

Reply via email to