3

アプリケーションのサイトを作成するためにMavenを使用したいと思います。これはマルチモジュールアプリであり、親モジュールは単純なサイトモジュールであり、最初の子はアプリのコアであり、2番目は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が収集されません。何が間違っていますか?

4

1 に答える 1

5

<reportPlugins>親pomのmaven-site-pluginの構成セクションで 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これで、親ディレクトリから実行できるようになります。集約されたjavadocを表示するには、ブラウザtarget/staging/index.htmlでそのディレクトリを指定し、ページの左側にあるインデックスで[プロジェクトレポート]、[JavaDocs]の順にクリックします。

追加のヒント:

全体を実行することなく、集約されたjavadocsをすばやく確認したい場合があります。これにより、より多くの処理site site:stageと時間がかかります。<plugin>そのため、親pomのセクションにmaven-javadoc-pluginの構成も直接含めます。mvn javadoc:aggregateそうすれば、で集約されたjavadocsを実行してすばやく取得できますtarget/site/apidocs/index.html

于 2013-07-10T19:37:22.470 に答える