本稿では maven-javadoc-plugin を利用して、Apache Maven で javadoc を生成する方法について解説します。
maven-javadoc-plugin
Maven で javadoc を作成するには maven-javadoc-plugin を利用します。 コマンドとしては次の通りです。
$ mvn javadoc:javadoc
maven-javadoc-plugin の設定を変更する場合は、Plugin の設定を pom.xml に次のように追記します。
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<author>true</author>
<source>1.7</source>
<show>protected</show>
<encoding>UTF-8</encoding>
<charset>UTF-8</charset>
<docencoding>UTF-8</docencoding>
</configuration>
</plugin>
maven-javadoc-plugin の主な設定パラメータは次の通りです。
| パラメータ | 概要 |
|---|---|
| author | javadoc に @author の記述を反映するか否かを設定できます。 (true / false) |
| charset | 生成される javadoc の HTML 内の meta タグに出力される文字エンコードを設定します。 |
| docencoding | javadoc の HTML ファイルの文字エンコードを設定します。 |
| encoding | ソースコードの文字エンコーディングを設定します。 |
| show | javadoc に含めるクラスのアクセスレベルを設定します。 デフォルトでは protected レベルのクラスまで含める事になっています。 “public”, “protected”, “private”, “package” の値を設定できます。 |
| source | ソースコードの Java バージョンを指定します。 |
その他のオプションや詳細な情報については、公式ページ を参考にしてください。
