2008年01月26日

JSDocというのをパッケージ化してみた

InDesign用スクリプトの公開にあたって、関数名/引数やファイル名がいまのところ不安定なのでAPIドキュメントについてはコード埋め込みにして自動化したい。JavaScript向けにはJavaDoc的なツールがいくつかあり、AppleのHeaderdocと、sf.netにあるJSDocあたりがメインストリームのようだ。

このうち、AppleのはApple IDを取得とか小面倒なのでパス。JSDocのほうを取得してパッケージングすることにした。どこを見てもライセンスがよくわからないのだが、sfにあるということは少なくともフリーソフトなのではあろう。とりあえずライセンスは「PDS?」としてパッケージ化。公式に持っていくつもりはないけど、誰かやりたいならスポンサーしてもよい。

パッケージはこちら。allアーキテクチャだし特にバージョン指定はないので、Sarge以上でUbuntuなどでも動作するはず。upstreamでは「jsdoc.pl」という名前だったのを「jsdoc」にしたのと、テンプレートパスがjsdoc.plからの相対になっていたのを/usr/share/jsdoc/に変更したくらい。

実際のところデフォルトのJavadoc的ドキュメント出力だと読みにくいので、サポートしているXML出力で吐き出させてそれを加工するという方法を今考え中。

リンク [hatena] | Debian