Mar 29, 2006

[Maven] Maven2 で API Document を生成する方法

Maven2 では maven-javadoc-plugin というプラグインが提供されており、このプラグインを使用することで簡単に API Document を生成できる。 但し、デフォルトの設定ではお約束のように 2 バイト文字が文字化けするので、多少設定が必要。

javadoc:javadoc
http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html

maven-javadoc-plugin の設定方法

<pom>
  <organization>
    <name>in-vitro.jp</name>  ←改行コードが入るとエラー
    <url>http://www.in-vitro.jp/</url>
  </organization>
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <configuration>
          <charset>Shift_JIS</charset>
        </configuration>
      </plugin>
    </plugins>
  </reporting>
</pom>

maven-javadoc-plugin の実行方法

JDK と Maven2 にパスを通したコンソールから、下記のコマンドを実行する。 生成された API Document は target/site に出力される。

  > mvn site

Posted in Maven | このエントリーをはてなブックマークに追加 | この記事をクリップ! livedoor クリップ |