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

Javadoc generation with includeDependencySources=true crashes when any of those dependencies have scope=provided dependencies

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Critical
    • Resolution: Cannot Reproduce
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Description

      Using this configuration in jbpm-distribution:

                  <configuration>
                    <includeDependencySources>true</includeDependencySources>
                    <dependencySourceIncludes>
                      <dependencySourceInclude>org.jbpm:*</dependencySourceInclude>
                    </dependencySourceIncludes>
                  </configuration>
      

      I got this:

      [INFO] ------------------------------------------------------------------------
      [INFO] BUILD FAILURE
      [INFO] ------------------------------------------------------------------------
      [INFO] Total time: 13.620s
      [INFO] Finished at: Tue Jan 17 15:05:07 CET 2012
      [INFO] Final Memory: 17M/441M
      [INFO] ------------------------------------------------------------------------
      [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.8:javadoc (javadoc-javadoc) on project jbpm-distribution: An error has occurred in JavaDocs report generation:
      [ERROR] Exit code: 1 - /home/gdesmet/projects/jboss/droolsjbpm/jbpm/jbpm-distribution/target/distro-javadoc-sources/jbpm-flow-5.3.0-SNAPSHOT-sources/org/jbpm/osgi/flow/core/Activator.java:26: package org.osgi.framework does not exist
      [ERROR] import org.osgi.framework.BundleActivator;
      

      Workaround: Explicitly add the provided scope dependencies one by one

          <dependency>
            <groupId>org.apache.felix</groupId>
            <artifactId>org.osgi.core</artifactId>
            <scope>provided</scope>
          </dependency>
          <dependency>
            <groupId>org.apache.felix</groupId>
            <artifactId>org.osgi.compendium</artifactId>
            <scope>provided</scope>
          </dependency>
      

      (and if you're doing this in an assembly, make sure your zips don't get to big or to small)

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                bmargulies Benson Margulies
                Reporter:
                ge0ffrey.desmet Geoffrey De Smet
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: