Maven 2.x Javadoc Plugin

Regression in 2.6.1 - modules with no sources cause an error

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Not A Bug
  • Affects Version/s: 2.6.1
  • Fix Version/s: None
  • Labels:
    None
  • Number of attachments :
    1

Description

After upgrading from 2.6 to 2.6.1 our Apache Cayenne builds got broken. The problem is in module with no public or protected sources (there's only a package-private class). Now, after infamous message "'org.apache.maven.plugins:maven-javadoc-plugin:2.6:javadoc' has not be
previously called for the project ..." build fails and creates an error report. In the report:

[INFO] ------------------------------------------------------------------------
[ERROR] BUILD ERROR
[INFO] ------------------------------------------------------------------------
[INFO] An error has occurred in JavaDocs report generation:
Exit code: 1 - javadoc: error - No public or protected classes found to document.

Command line was: C:\Progra~1\Java\jdk1.6.0_13\jre\..\bin\javadoc.exe @options @packages

Refer to the generated Javadoc files in 'C:\Project\cayenne-parent\framework\cayenne-jdk1.6-unpublished\target\site\apidocs' dir.

Issue Links

relates to

Bug - A problem which impairs or prevents the functions of the product. MJAVADOC-306 javadoc fails when no classes are found to document

  • Minor - Minor loss of function, or other problem where easy workaround is present.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Andrey Razumovsky added a comment -

And one more thing. I'm not sure about the reason, but both in 2.6 and 2.6.1, when we try to disable this new feature by setting detectOfflineLinks=false, Maven build succeeds, but Hudson cannot publish JavaDoc. Seems like some docs were not properly built. See error at very end of log:
http://hudson.zones.apache.org/hudson/job/Cayenne-trunk/jdk=JDK%201.5%20%28latest%29/28/console

FATAL: /export/home/hudson/hudson/jobs/Cayenne-trunk/workspace/jdk/JDK 1.5 (latest)/trunk/framework/cayenne-jdk1.5-unpublished/target/site/apidocs not found.

Show
Andrey Razumovsky added a comment - And one more thing. I'm not sure about the reason, but both in 2.6 and 2.6.1, when we try to disable this new feature by setting detectOfflineLinks=false, Maven build succeeds, but Hudson cannot publish JavaDoc. Seems like some docs were not properly built. See error at very end of log: http://hudson.zones.apache.org/hudson/job/Cayenne-trunk/jdk=JDK%201.5%20%28latest%29/28/console FATAL: /export/home/hudson/hudson/jobs/Cayenne-trunk/workspace/jdk/JDK 1.5 (latest)/trunk/framework/cayenne-jdk1.5-unpublished/target/site/apidocs not found.
Hide
Permalink
Stevo Slavic added a comment -

This is Java's javadoc tool reporting error. Just skip maven-javadoc-plugin execution for such module.

Show
Stevo Slavic added a comment - This is Java's javadoc tool reporting error. Just skip maven-javadoc-plugin execution for such module.
Hide
Permalink
John Casey added a comment -

I created a test for this issue, but cannot get it to fail using version 2.6.1. Can someone who's experiencing this issue please take a look and tell me where I've gone wrong?

I can't get this fixed until we have a test to verify the problem, so I'm sure when I have it fixed.

Show
John Casey added a comment - I created a test for this issue, but cannot get it to fail using version 2.6.1. Can someone who's experiencing this issue please take a look and tell me where I've gone wrong? I can't get this fixed until we have a test to verify the problem, so I'm sure when I have it fixed.
Hide
Permalink
Andrey Razumovsky added a comment -

I'm not sure I remember the issue properly, but for your test, try to make App class package-private

Show
Andrey Razumovsky added a comment - I'm not sure I remember the issue properly, but for your test, try to make App class package-private
Hide
Permalink
Herve Boutemy added a comment -

ok, I can reproduce the error by getting John's test and applying Andrey modification (removed "public" class declaration)

now my question is: what can we do when javadoc can't generate anything?

a workiaroud is to configure <failOnError>false</failOnError>

Show
Herve Boutemy added a comment - ok, I can reproduce the error by getting John's test and applying Andrey modification (removed "public" class declaration) now my question is: what can we do when javadoc can't generate anything? a workiaroud is to configure <failOnError>false</failOnError>
Hide
Permalink
Benson Margulies added a comment -

Since the javadoc tool itself does not like this situation, why is it up to us to work around?

I propose to close this based on Hervé's observation.

Show
Benson Margulies added a comment - Since the javadoc tool itself does not like this situation, why is it up to us to work around? I propose to close this based on Hervé's observation.

People

  • Assignee:
    John Casey
    Reporter:
    Andrey Razumovsky
Vote (2)
Watch (7)

Dates

  • Created:
    Updated:
    Resolved: