[MJAVADOC-767] javadoc creates invalid --patch-module statements

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.5.0
• Fix Version/s: 3.6.0
• Component/s: jar
• Assignee: Henning Schmiedehausen
• Reporter: Henning Schmiedehausen
• Created: 17/Aug/23 05:00
• Updated: 15/Sep/23 18:28
• Resolved: 02/Sep/23 00:27

Description

Jdbi is a mixed Java/Kotlin multi-module project. We aggregate a final jar that contains all the javadocs for all modules in a doc step. This works ok for non-JPMS (Java 8 target).

When introducing JPMS into our project, the javadoc plugin starts adding --patch-module options like this:

--patch-module org.jdbi.v3.caffeine='/Users/henning/code/jdbi/cache/caffeine-cache/src/main/java:/Users/henning/code/jdbi/cache/caffeine-cache/target/generated-sources/annotations'

However, in our configuration, we exclude the kotlin specific modules:

  <plugin>
    <artifactId>maven-javadoc-plugin</artifactId>
    <executions>
        <execution>
            <id>javadoc-jar</id>
            <goals>
                <goal>jar</goal>
            </goals>
            <phase>package</phase>
            <configuration>
                <includeDependencySources>true</includeDependencySources>
                <detectOfflineLinks>false</detectOfflineLinks>
                <dependencySourceIncludes>
                    <dependencySourceInclude>org.jdbi:*</dependencySourceInclude>
                </dependencySourceIncludes>
                <dependencySourceExcludes>
                    <dependencySourceExclude>org.jdbi:jdbi3-kotlin</dependencySourceExclude>
                    <dependencySourceExclude>org.jdbi:jdbi3-kotlin-sqlobject</dependencySourceExclude>
                </dependencySourceExcludes>
                <skippedModules>jdbi3-kotlin,jdbi3-kotlin-sqlobject</skippedModules>
                <doctitle>Jdbi3 ${project.version} API</doctitle>
                <windowtitle>Jdbi3 ${project.version} API</windowtitle>
            </configuration>
        </execution>
    </executions>
  </plugin>

which results in the maven-javadoc-plugin creating command line options like this:

--patch-module org.jdbi.v3.kotlin=

which in turn crash the javadoc command.

Issue Links

• links to: GitHub Pull Request #225