Flex SDK, asdocコマンドでAPI ドキュメント出力

Actionscriptライブラリに付属Documentがなかったら作れるよ、な話。

Flex SDK, bin ディレクトリのasdocがそれ。
たぶんjavadocと同じようなものだと思う。

今回はドキュメントのない HydroTween の API ドキュメントを出力した。

SDKはアップデートが多いのでパスを通すのを止めた。
Flex SDK bin ディレクトリへ移動。

./asdoc -source-path [ライブラリパス]
 -main-title "[タイトル]"
 -window-title "[ウインドウ　タイトル]"
 -output [出力先パス]
 -doc-classes com.hydrotik.go.HydroSequence

ライブラリパス
ライブラリを置いているところ。
lib -|
     |-com
     |-org
だったらlibまでのパス。
HydroTweenだけでなくGoASAPも配置しておく。

-doc-classes
com.hydrotik.go.HydroSequenceを指定したのはHydroSequenceがHydroTweenをimportしているので両方のドキュメントを出力できるから。

正常に終了すると出力先指定フォルダにHTMLファイルができるので index.html を開く。

HydroTweenはASDoc形式で書かれていないのでマニュアルのようには使えない。
メソッド・プロパティの一覧や継承関係は確認できる。