Hatena::Groupocaml-nagoya

UX-Framework開発日誌

2009-03-18haxeのドキュメント生成ツールchxdocを使ってみました

haxeのドキュメント生成ツールchxdocを使ってみました

20:36 | haxeのドキュメント生成ツールchxdocを使ってみました - UX-Framework開発日誌 を含むブックマーク はてなブックマーク - haxeのドキュメント生成ツールchxdocを使ってみました - UX-Framework開発日誌

haxeのソースコードからドキュメントを生成するためにhaxedocというツールが標準でインストールされますが、より見やすくて使いやすいドキュメントを得るためにchxdoc(version 0.7.3)を使ってみました。


chxdocはhaxedocと同様に、コンパイルオプション -xml で生成されたxmlファイルからドキュメントを構築するようです。


ダウンロードしてPATHを通したら、templateをプロジェクトのディレクトリにコピーしてきましょう。

 $ cp -r DOWNLOADDIR/chxdoc_0_7_3/template ./

次のようにして使うことができます。

 $ haxe -xml myproject.xml ....
 $ chxdoc -o docs --tmpDir=_chxdoctmp --templateDir=templates/default \
--installTemplate=true --developer=false myproject.xml

これで、このようなかっこいいドキュメントHTMLが生成されます。


ただ、バグを一つ発見してしまいました。それは各クラスの一番上のクラス名の部分がHTMLエンコーディングされないということです。このため MyClass<A> のような型パラメータを持つクラスを定義した場合、その部分がHTMLタグみたいになってしまい、ブラウザで意図通りに表示されなくなってしまいます。型パラメータを<S>とかにした場合はクラス名以下の文章が打ち消し線になってしまうのです!!


[追記]

バグの原因を見つけてパッチを作りました。これでうまく使えます。

JosueJosue 2012/12/08 01:06 It's good to get a fresh way of lokoing at it.

mvdbmpbjmvdbmpbj 2012/12/08 18:40 rdseGL <a href="http://kwtjyqpynman.com/">kwtjyqpynman</a>

eqogrdeqogrd 2012/12/10 00:02 j1vFpg , [url=http://xffmcgutuncm.com/]xffmcgutuncm[/url], [link=http://lnchqyshnyue.com/]lnchqyshnyue[/link], http://bpiqwtqzgxct.com/

zhgjsknzhgjskn 2012/12/13 01:44 6Ss9aO , [url=http://daqnhnwvesno.com/]daqnhnwvesno[/url], [link=http://ventcmcgwdrw.com/]ventcmcgwdrw[/link], http://nkccxrexsmcs.com/

ゲスト



トラックバック - http://ocaml-nagoya.g.hatena.ne.jp/uxtk/20090318