たごもりすメモ

コードとかその他の話とか。

Javadocを生成してからDocsetを生成する

このとき普通にjavadocコマンドを使うと日本語テンプレートが使われてウザいので英語でやる。主にEsperのバージョンを上げたりするときに重宝するやつ。

javadoc生成

ずばり、以下のようなコマンドでやる。

LC_ALL=en_US javadoc -locale en_US -d doc -sourcepath src -subpackages com.espertech.esper -private

src内の com.espertech.esper 以下のパッケージについて再帰的に、doc以下に生成する。このとき -private オプションをつけてprivateなスコープのものについても生成する。
このままやると日本語テンプレートが使われてアレなので -locale en_US を指定すると英語のものが使われてよい。ついでにコマンド実行中の出力も英語にしちゃいたいから LC_ALL=en_US を指定。

docset生成

Dashが非常に便利で、Javadocの閲覧はだいたいこいつを使っている。

Dash - API Docs & Snippets

Dash - API Docs & Snippets

JavadocからDocset形式に変換してやる必要がある。

Kapeli/javadocset · GitHub

これのバイナリをそのまま落としてパスの通ったところに展開して以下のコマンドを叩く。ちょっと待つ。

javadocset Esper-5.2 doc

あとはできたものをDashに放り込めばよい。やれやれ。