mavenでJavadoc出力

投稿日：2015年4月22日

Netbeansでプロジェクトから右クリックでjavadocの生成はできますが、実はmavenでビルドするときにJavadocを生成できます。

ただ出力するだけではなくてパラーメータをいろいろとセットできます。

javadoc出力プラグイン

以下をpom.xmlに記述しておけばOKです。

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <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>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-javadoc-plugin</artifactId>

<show>protected</show>

</configuration>

</plugin>

configurationにパラメーターを設定できます。

パラメータ	概要
author	javadoc に @author の記述を反映するか否かを設定できます。 (true / false)
charset	生成される javadoc の HTML 内の meta タグに出力される文字エンコードを設定します。通常はUTF-8にしておきましょう。
docencoding	javadoc の HTML ファイルの文字エンコードを設定します。通常はUTF-8にしておきましょう。
encoding	ソースコードの文字エンコーディングを設定します。通常はUTF-8にしておきましょう。
show	javadoc に含めるクラスのアクセスレベルを設定します。デフォルトでは protected レベルのクラスまで含める事になっています。 “public”, “protected”, “private”, “package” の値を設定できます。通常はprivateのプロパティやメソッドはjavadocに出力されませんが、ここでprivateを設定しておけばJavadocに出力されます。
source	ソースコードの Java バージョンを指定します。 2015年4月現在はJava8が最新ですので1.8です。

このように設定しておきますとビルド時にjavadocのHTMLが生成されます。

下記を参考にさせてもらいました。

http://weblabo.oscasierra.net/maven-javadoc-plugin-1/

ちなみにmavenでjavadocを出力する際のゴールはsiteで、

mvn javadoc:javadocでも出力できます。

さまざまなパラメーターがあり、いろいろとカスタマイズできます。

下記のリンクに詳しくのっています。

http://happy-camper.st/lang/java/maven2/plugins/maven-javadoc-plugin.html