Maven で Javadoc を生成する方法

• 概要
• 環境
• プロジェクト作成
• Javadoc 出力設定
• pom.xml に定義する場合
• 最後に

概要

Maven で Javadoc を作成してみました

環境

• Mac OS X 10.10.3
• Eclipse Luna 4.4
• Java 1.8.0_31
• Maven 3.2.1

プロジェクト作成

プロジェクトは Eclipse 上で作成しました
以下の Group Id と Artifact Id を指定しています

• Group Id･･･org.apache.maven.archetypes
• Artifact Id･･･maven-archetype-quickstart

Javadoc 出力設定

上記 Artifact Id で作成すれば特に何もしなくても Javadoc を生成することができます
以下の goal を指定すれば作成できます

mvn javadoc:javadoc

上記で実行するとtarget/site/apidoc/index.htmlに Javadoc の index.html が生成されます
2015/06/15 現在だと使用されるmaven-javadoc-pluginのバージョンは2.10.3でした

pom.xml に定義する場合

例えば出力先や文字コードを変更したい場合はpom.xmlに記載する必要があります
<project>-><build>-><plugins>配下に以下を記載してください

<!-- Javadoc -->
<plugin>
   <groupId>org.apache.maven.plugins</groupId>
   <artifactId>maven-javadoc-plugin</artifactId>
   <version>2.10.3</version>
   <configuration>
      <author>true</author>
      <source>1.8</source>
      <show>protected</show>
      <encoding>UTF-8</encoding>
      <charset>UTF-8</charset>
      <docencoding>UTF-8</docencoding>
   </configuration>
</plugin>

<version>に使用するプラグインのバージョンを指定します
<encoding>にJavaのソースファイルのエンコードを指定します
<charset>に出力するHTMLの文字コードを指定します
<docencoding>は<charset>と同じ（だと思います）

他の詳しいパラメータはここを参考にしてください

実行する場合は先ほど同様でmvn javadoc:javadocでOKです

最後に

mvn packageのライフサイクルに入れるにはどうすればいいのだろうか