You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Vincent Siveton (JIRA)" <ji...@codehaus.org> on 2007/07/27 04:43:13 UTC

[jira] Created: (MJAVADOC-138) javadoc:test-javadoc failed if target/classes not already created

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

        

[jira] Commented: (MJAVADOC-138) javadoc:test-javadoc failed if target/classes not already created

Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MJAVADOC-138?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_120327 ] 

Vincent Siveton commented on MJAVADOC-138:
------------------------------------------

Benjamin, could you provide us a patch?

> 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

        

[jira] Commented: (MJAVADOC-138) javadoc:test-javadoc failed if target/classes not already created

Posted by "Benjamin Bentmann (JIRA)" <ji...@codehaus.org>.
    [ 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

        

[jira] Commented: (MJAVADOC-138) javadoc:test-javadoc failed if target/classes not already created

Posted by "Benjamin Bentmann (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MJAVADOC-138?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_120393 ] 

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

I really should stop commenting on other people's issues...  Not sure if I am willing to spend time on this. I will check out its complexity during the weekend and let you know if I go for it or not.

> 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

        

[jira] Commented: (MJAVADOC-138) javadoc:test-javadoc failed if target/classes not already created

Posted by "Benjamin Bentmann (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MJAVADOC-138?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_120685 ] 

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

Vincent, if there is urgent need to get this done, I can't help. If it can wait a couple of weeks, well, I will try.

As a hotfix, annotating the mojo with {{@execute phase=test-compile}} to create the test classes by a forked Maven invocation should do.

> 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

        

[jira] Commented: (MJAVADOC-138) javadoc:test-javadoc failed if target/classes not already created

Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MJAVADOC-138?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_121712 ] 

Vincent Siveton commented on MJAVADOC-138:
------------------------------------------

Benjamin, it is not *so* urgent, I am happy to waiting for it :)

> 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

        

[jira] Closed: (MJAVADOC-138) javadoc:test-javadoc failed if target/classes not already created

Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MJAVADOC-138?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Vincent Siveton closed MJAVADOC-138.
------------------------------------

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

Should be closed by MJAVADOC-168  

> 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
>            Assignee: Vincent Siveton
>             Fix For: 2.5
>
>
> 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