[ 
http://jira.codehaus.org/browse/MJAVADOC-280?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=217073#action_217073
 ] 
John Casey commented on MJAVADOC-280:
-------------------------------------

This is a configuration I inserted into the apache-maven project in my local 
workdir of maven-2, in order to see the new feature in action:

{code:xml}
    <profile>
      <id>javadocs</id>
      <build>
        <plugins>
          <plugin>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.6.2-SNAPSHOT</version>
            <configuration>
              <includeDependencySources>true</includeDependencySources>
              <detectOfflineLinks>false</detectOfflineLinks>
              <dependencySourceIncludes>
                
<dependencySourceInclude>org.apache.maven:*</dependencySourceInclude>
              </dependencySourceIncludes>
            </configuration>
            <executions>
              <execution>
                <id>distro-javadocs</id>
                <goals>
                  <goal>jar</goal>
                  <goal>test-jar</goal>
                </goals>
              </execution>
            </executions>
          </plugin>
        </plugins>
      </build>
    </profile>
{code}

NOTE: To get the test-jar stuff working when the full maven project structure 
isn't built (i.e. building from apache-maven standalone), I had to add the 
following to the top-level pom.xml in the maven-2 workdir:

{code:xml}
    <profile>
      <id>javadocs</id>
      <build>
        <plugins>
          <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-source-plugin</artifactId>
            <executions>
              <execution>
                <id>attach-sources</id>
                <goals>
                  <goal>jar</goal>
                </goals>
              </execution>
              <execution>
                <id>attach-test-sources</id>
                <goals>
                  <goal>test-jar</goal>
                </goals>
              </execution>
            </executions>
          </plugin>
        </plugins>
      </build>
    </profile>
{code}


> Allow creation of aggregated javadocs source bundles from project dependencies
> ------------------------------------------------------------------------------
>
>                 Key: MJAVADOC-280
>                 URL: http://jira.codehaus.org/browse/MJAVADOC-280
>             Project: Maven 2.x Javadoc Plugin
>          Issue Type: New Feature
>    Affects Versions: 2.6.1
>            Reporter: John Casey
>            Assignee: John Casey
>             Fix For: 2.6.2
>
>         Attachments: aggregate-from-dependencies.patch
>
>
> It would be nice to have the ability to generate an aggregated javadoc set 
> for a distribution project by resolving the -sources and -test-sources 
> bundles of its dependencies (or, correspondingly, the 
> project.compileSourceRoots and project.testCompileSourceRoots for modules in 
> the same reactor).
> Initially, this might just mean downloading, unpacking, and adding the 
> dependency sources as sourcepaths to the javadoc execution if a flag is set 
> to true (includeDependencySources). Later, we could easily expand this to 
> allow bundling and deployment of the src/main/javadoc directory so that this 
> artifact can be used in the above aggregation approach.
> I've got an implementation of the first part that I will attach to this issue 
> as a patch to illustrate what I'm talking about.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: 
http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Reply via email to