Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-55692

Java 11 Javadoc generation fails in maven

XMLWordPrintable

      When compiling the platformlabeler-plugin with Java 11.0.2 using mvn clean install, it fails the build because the Java 11.0.2 javadoc command reports:

      [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.0.1:javadoc (default-cli) on project platformlabeler: An error has occurred in Javadoc report generation:
[ERROR] Exit code: 1 - javadoc: error - The code being documented uses modules but the packages defined in https://docs.oracle.com/javase/8/docs/api/ are in the unnamed module.
[ERROR]
[ERROR] Command line was: /usr/lib/jvm/java-11-openjdk-amd64/bin/javadoc @options @packages
[ERROR]
[ERROR] Refer to the generated Javadoc files in '/home/mwaite/git/jenkins/platformlabeler-plugin/target/site/apidocs' dir.

      Simplest solution for the platformlabeler-plugin is to disable javadoc.

      That solution isn't viable for other plugins (like the git client plugin), but works for platformlabeler-plugin.

      Hints in other locations indicate that a change to the maven javadoc plugin 3.1.0 is expected to resolve the issue

          [JENKINS-55692] Java 11 Javadoc generation fails in maven

          Mark Waite added a comment -

          Fixed on the platformlabeler-plugin master branch. No release required, since this is javadoc only and javadoc is not delivered to end users.

          Mark Waite added a comment - Fixed on the platformlabeler-plugin master branch. No release required, since this is javadoc only and javadoc is not delivered to end users.

          cowwoc added a comment -

          maven-javadoc-plugin 3.1.0 fixes this problem and it should be released in the coming days if it isn't already out. The github repository shows they made a release 2 days ago but maven central doesn't seem to have it yet. Either way, please retest with this plugin.

          cowwoc added a comment - maven-javadoc-plugin 3.1.0 fixes this problem and it should be released in the coming days if it isn't already out. The github repository shows they made a release 2 days ago but maven central doesn't seem to have it yet. Either way, please retest with this plugin.

          Carlos Saltos added a comment -

          Adding <detectJavaApiLink>false</detectJavaApiLink> to the Maven javadoc pluging configuration fix the error as a workaround (since maven-javadoc-plugin 3.2.0 still has this bug)

          Carlos Saltos added a comment - Adding <detectJavaApiLink>false</detectJavaApiLink> to the Maven javadoc pluging configuration fix the error as a workaround (since maven-javadoc-plugin 3.2.0 still has this bug)

          cowwoc added a comment -

          csaltos This bug is marked as fixed. If you are seeing it in version 3.2.0 please file a new (separate) bug report.

          cowwoc added a comment - csaltos This bug is marked as fixed. If you are seeing it in version 3.2.0 please file a new (separate) bug report.

            markewaite Mark Waite
            markewaite Mark Waite
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: