Maven Javadoc Plugin

Goals

Javadocプラグインには6つのゴールがあります。

• javadoc:javadoc
  メインのソースコードを元にJavadocを生成します。
  
• javadoc:test-javadoc
  テストコードを元にJavadocを生成します。
  
• javadoc:aggregate
  モジュールも含めたメインのソースコードを元にJavadocを生成します。
  
• javadoc:test-aggregate
  モジュールも含めたテストコードを元にJavadocを生成します。
  
• javadoc:jar
  メインのソースコードを元に生成したJavadocをjarにまとめます。
  
• javadoc:test-jar
  テストコードを元に生成したJavadocをjarにまとめます。
  

使い方

メインのソースコードを元にJavadocを生成

$ mvn javadoc:javadoc

デフォルトではtarget/site/apidocs以下にJavadocが生成されます。

テストコードを元にJavadocを生成

$ mvn javadoc:test-javadoc

デフォルトではtarget/site/testapidocs以下にテストコードのJavadocが生成されます。

モジュールも含めたメインのソースコードを元にJavadocを生成

$ mvn javadoc:aggregate

デフォルトではtarget/site/apidocs以下にモジュールも含めたJavadocが生成されます。

モジュールも含めたテストコードを元にJavadocを生成

$ mvn javadoc:test-aggregate

デフォルトではtarget/site/testapidocs以下にモジュールも含めたテストコードのJavadocが生成されます。

メインのソースコードを元に生成したJavadocをjarにまとめる

$ mvn javadoc:jar

デフォルトではtarget/${finalName}-javadoc.jarとしてJavadocをまとめたjarが生成されます。

テストコードを元に生成したJavadocをjarにまとめる

$ mvn javadoc:test-jar

デフォルトではtarget/${finalName}-test-javadoc.jarとしてJavadocをまとめたjarが生成されます。

設定

よく使う設定、便利な設定を紹介します。
その他の設定については、javadoc:javadoc、javadoc:test-javadoc、javadoc:aggregate、javadoc:test-aggregate、javadoc:jar、javadoc:test-jarを参照してください。

encoding

Javaソースファイルの文字コードを指定します。
デフォルトは、file.encodingシステムプロパティの値です。

設定例

<project>

	・・・・

	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-javadoc-plugin</artifactId>
				<configuration>
					<encoding>UTF-8</encoding>
				</configuration>
			</plugin>
		</plugins>

	・・・・

	</build>

	・・・・

</project>

packageフェーズでjavadoc.jarを生成する

jarゴールがpackageフェーズで起動するよう、<execution>タグで設定します。

設定例

<project>

	・・・・

	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-javadoc-plugin</artifactId>
				<configuration>
					<encoding>UTF-8</encoding>
				</configuration>
				<executions>
					<execution>
						<phase>package</phase>
						<goals>
							<goal>jar</goal>
						</goals>
					</execution>
				</executions>
			</plugin>
		</plugins>

	・・・・

	</build>

	・・・・

</project>

この設定により、生成されたjavadoc.jarファイルがインストール/デプロイされるようになります。

プロジェクトサイトにJavadocレポートを含める

siteフェーズで生成されるプロジェクトサイトからJavadocレポートへリンクされるようにします。
<build>タグではなく、<reporting>タグ内に設定します。

設定例

<project>

	・・・・

	<reporting>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-javadoc-plugin</artifactId>
				<configuration>
					<encoding>UTF-8</encoding>
				</configuration>
			</plugin>
		</plugins>

	・・・・

	</reporting>

	・・・・

</project>