使用javadoc的Maven多模块项目站点

Question

我想使用Maven为我的应用程序创建站点。这是一个多模块的app，父模块是简单的site模块，第一个子模块是app的核心，第二个是GUI (Swing)。

我现在对父pom.xml使用follow

<modules>
    <module>core</module>
    <module>kayako-desktop</module>
</modules>
<build>
    <plugins>
        <plugin>
            <artifactId>maven-site-plugin</artifactId>
            <version>2.2</version>
            <configuration>
                <locales>en</locales>
            </configuration>
        </plugin>
        <plugin>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.7</version>
            <executions>
                <execution>
                    <phase>install</phase>
                    <goals>
                        <goal>aggregate</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>
<reporting>
    <plugins>
        <plugin>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.7</version>
            <configuration>
                <aggregate>true</aggregate>
            </configuration>
        </plugin>
        <plugin>
            <artifactId>maven-changes-plugin</artifactId>
            <version>2.4</version>
        </plugin>
    </plugins>
</reporting>

我的核心是pom：

<build>
    <plugins>
        <plugin>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.7</version>
            <executions>
                <execution>
                    <phase>package</phase>
                    <id>attach-javadocs</id>
                    <goals>
                        <goal>jar</goal>
                        <goal>javadoc</goal>
                    </goals>
                </execution>

            </executions>
        </plugin>
    </plugins>
</build>
<reporting>
    <plugins>
        <plugin>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.7</version>
            <configuration>
                <links>
                    <link>http://download.oracle.com/javase/6/docs/api/</link>
                </links>    
            </configuration>
        </plugin>    
    </plugins>

</reporting>

(我去掉了两者中不相关的部分)

问题:我尝试了mvn site:stage，但是javadoc不是从核心模块收集的。我做错了什么？

Answer 1

在父pom中maven-site-plugin的配置的<reportPlugins>部分配置javadoc插件。

以下是对我起作用的方法。

在父pom中：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-site-plugin</artifactId>
            <version>3.3</version>
            <configuration>
                <reportPlugins>
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-javadoc-plugin</artifactId>
                        <version>2.9</version>
                        <reportSets>
                            <reportSet>
                                <id>aggregate</id>
                                <reports>
                                    <report>aggregate</report>
                                </reports>
                            </reportSet>
                        </reportSets>
                        <configuration>
                        <!-- Here you can add special configurations for your javadoc, if needed -->
                        </configuration>
                    </plugin>
                    <!-- Here you can also configure more report plugins -->
                    <!-- for your site, such as maven-project-info-reports-plugin -->
                </reportPlugins>
            </configuration>
        </plugin>
    <!-- ... -->
    </plugins>
</build>
<!-- ... -->
<distributionManagement>
    <site>
        <id>website</id>
        <url>http://site.url/can/be/tentative/or/hypothetical</url>
    </site>
</distributionManagement>

在每个子pom中，您还可以为站点插件配置特定的报告，例如，surefire测试报告或项目信息。但是，您不需要在其中放置任何javadoc插件配置(除非您还希望对子模块使用非聚合的javadoc)。

然后，您应该能够从父目录执行mvn site site:stage。要查看聚合的javadocs，请将浏览器指向该目录中的target/staging/index.html，然后单击页面左侧索引中的"Project Reports“和"JavaDocs”。

附加提示：

有时，我想快速查看聚合的site site:stage，而不必执行完整的javadoc，这会做更多的事情，花费更长的时间。因此，我还在父pom的<plugin>部分直接包含了maven-javadoc-plugin的配置。这样，我就可以在target/site/apidocs/index.html中运行mvn javadoc:aggregate并快速获得聚合的javadoc。