JavaDoc を Doclava で生成するようにしたら捗った
Java のドキュメントと言えば JavaDoc ですが
見た目があまりにもダサ過ぎやしませんかね?
こんなんじゃ JavaDoc を書くモチベーションが下がってしまいます。
そこで JavaDoc を Doclava で生成するようにしました。
Google Code Archive - Long-term storage for Google Code Project Hosting.
するとこんな風に今時のかっこいいデザインで出力されます。
検索ボックスは、パッケージ名とクラス名を
インクリメンタル検索ができて機能的にも便利です。
使い方
Maven で使う場合には reporting 要素の下に以下のように書きます。
<reporting> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>2.8.1</version> <configuration> <docencoding>UTF-8</docencoding> <charset>UTF-8</charset> <encoding>UTF-8</encoding> <bootclasspath>${sun.boot.class.path}</bootclasspath> <doclet>com.google.doclava.Doclava</doclet> <useStandardDocletOptions>false</useStandardDocletOptions> <additionalJOption>-J-Xmx1024m</additionalJOption> <docletArtifact> <groupId>com.google.doclava</groupId> <artifactId>doclava</artifactId> <version>1.0.3</version> </docletArtifact> <additionalparam> -hdf project.name "${project.name}" -d ${project.reporting.outputDirectory}/apidocs </additionalparam> </configuration> <reportSets> <reportSet> <id>default</id> <reports> <report>javadoc</report> </reports> </reportSet> </reportSets> </plugin> </plugins> </reporting>
その他の環境での使い方は Google Code Archive - Long-term storage for Google Code Project Hosting. をご参照ください。