Uploaded image for project: 'Maven Javadoc Plugin'
  1. Maven Javadoc Plugin
  2. MJAVADOC-707

Plugin won't work if Automatic-Module-Name is used

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Closed
    • Critical
    • Resolution: Fixed
    • 3.3.1, 3.3.2, 3.4.0
    • 3.6.0
    • None

    Description

      Using Automatic-Module-Name in a manifest (an intermediate step to help transition to using modules) prevents this plugin from adding the necessary dependencies to the class path, so it can build javadocs.

      maven-compiler-plugin seems to work fine, as does surefire and all the others when Automatic-Module-Name entries appear in a project's jar manifests. However, this plugin, as of 3.3.1, still does not work correctly with these.

      Instead of using the traditional class path, this plugin seems to force treating the project as a module, even though it does not have any module-info.java files, and most of its dependencies have not transitioned to using modules.

      Here's a pull request that demonstrates adding the Automatic-Module-Name to the manifest for a multi-module (Maven module) project, that fails on the javadoc plugin:
      https://github.com/apache/accumulo/pull/2498 ; both javadoc:aggregate and javadoc:jar are known to fail. I did not test with any other mojos.

      Not supporting this feature holds all projects back from being able to transition to modules over time.

      http://branchandbound.net/blog/java/2017/12/automatic-module-name/

      https://docs.oracle.com/javase/9/docs/api/java/lang/module/ModuleFinder.html#automatic-modules

      Attachments

        Issue Links

          Activity

            People

              henning Henning Schmiedehausen
              ctubbsii Christopher Tubbs
              Votes:
              4 Vote for this issue
              Watchers:
              9 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: