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

Setting the output directory affects dependencySourceIncludes

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Resolved
    • Major
    • Resolution: Cannot Reproduce
    • 3.5.0
    • None
    • javadoc
    • None

    Description

      I have a large, multi-module build (github.com/jdbi/jdbi) where we build separate javadoc jars for all modules. These are built with a javadoc plugin configuration that writes the javadoc information into target/apidocs. This works fine.

      At the end of our build we aggregate all the separate javadoc modules into a single documentation site.

      This is the javadoc configuration for that:

      {{<configuration>
      <outputDirectory>${project.build.directory}/generated-docs/apidocs</outputDirectory>
      <includeDependencySources>true</includeDependencySources>
      <dependencySourceIncludes>
      <dependencySourceInclude>org.jdbi:*</dependencySourceInclude>
      </dependencySourceIncludes>
      <doctitle>Jdbi3 ${project.version} API</doctitle>
      <windowtitle>Jdbi3 ${project.version} API</windowtitle>
      </configuration>
      }}

      The reactor build tries to load the included modules (org.jdbi:*) but does not look into the target/apidocs folder where the javadoc was written but from target/generated-docs/apidocs. Setting the output directory for the aggregation module affects the directory that the javadoc plugin uses to resolve the dependencySourceInclude directory.

      Expected effect: Setting the output directory only affects the place where the aggregated doc is written. The plugin still picks up the existing javadoc from the target/apidocs folders in the included modules

      Observed effect: Setting the output directory makes the plugin look at the wrong folders for the included moduled and does not find the existing documentation

      Attachments

        Activity

          People

            henning Henning Schmiedehausen
            henning Henning Schmiedehausen
            Votes:
            1 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: