[Maven] 全モジュールをまとめた Javadoc を生成するメモ

「Aggregating Maven Javadoc Plugin - Javadocs for Multi-Projects」から、全モジュールをまとめた Javadoc を生成する設定をメモしておきます。

通常、複数のモジュールで構成されているプロジェクトで javadoc:javadoc ゴールを実行すると、モジュールごとに別々の Javadoc が生成されます。しかし、プロジェクトで最上位の pom.xml に設定を行うと、プロジェクト全体のドキュメントを生成できます。

具体的には、maven-javadoc-plugin の設定で aggregate 要素を true に設定します。（以下の例で「...」は省略を表します）

...
  <reporting>
    <plugins>
      ...
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <configuration>
          ...
          <aggregate>true</aggregate>
          ...
        </configuration>
      </plugin>
      ...
    </plugins>
  </reporting>
...

maven-javadoc-plugin を設定している部分が build 要素内ではなく reporting 要素内である部分に注意してください。reporting 要素とは、プロジェクトに関するレポート（ウェブページや Javadoc、テスト結果など）の設定を行う部分です。

aggregate 要素を false にすると、通常通り、モジュールごとの Javadoc が生成されます。

参考文献

• POM Reference 3. Build Settings