Edited at

JavadocをAPIドキュメントに変換する

More than 5 years have passed since last update.


Gradleを使う

Gradleで管理しているプロジェクトで、

  gradle javadoc

コマンドを実行すれば、build > docs > javadoc にドキュメントが生成される。


生成されたAPIドキュメント

JUnitPractice_1_0_0-SNAPSHOT_API_と_Macintosh_HD.png

JUnitPractice_1_0_0-SNAPSHOT_API.png

JUnitPractice_1_0_0-SNAPSHOT_API?.png

Java7、Java8のAPIドキュメントっぽく生成される。

PJをUTF-8でつくってるんだけど、日本語文字列のエンコードでエラーになった。

build.gradleに以下のEncodingの設定を追加したら解決した。


追加した設定

javadoc {

options.encoding = "UTF-8"
}

発生したエラー

/Users/syobochim/dev/JUnitPractice/src/main/java/ch06/ItemStock.java:6: ???: ??????????????ASCII?????????

* ??????????????????????????????????????????
^


maven を使う

maven で管理しているプロジェクトで

mvn javadoc:javadoc

のコマンドを実行すれば target > site > apidocs にAPIドキュメントが生成される。


生成されたAPIドキュメント

sample_1_0-SNAPSHOT_API.png


追加した設定

Encodingのエラーは

[ERROR] * maven ?????????????????????????????????

[ERROR] ^
[ERROR] /Us

pom.xmlに以下の設定を追加したらなおった。

    <properties>

<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>