Flex 2 アプリケーションの構築とデプロイ > Flex アプリケーションの構築 > ASDoc の使用 > ASDoc ツールについて

ASDoc ツールについて

ASDoc ツールは、1 つまたは複数の ActionScript クラス定義と MXML ファイルを解析し、すべてのパブリックメソッドとプロパティ、保護されたメソッドとプロパティ、また、すべての [Bindable]、[DefaultProperty]、[Event]、[Style]、および [Effect] メタデータタグの API 言語参照ドキュメントを生成します。

1 つのクラス、複数のクラス、名前空間全体、またはこれらの入力の組み合わせを ASDoc ツールへの入力として指定できます。

ASDoc は、入力クラスファイルのパッケージ構造に一致する HTML ファイルのディレクトリ構造としてその出力を生成します。また、ASDoc は、パブリックメソッドとプロパティ、保護されたメソッドとプロパティのすべてのインデックスを生成します。ASDoc 出力を表示するには、出力のトップレベルディレクトリから "index.html" ファイルを開きます。

ASDoc ツールの呼び出し

ASDoc を呼び出すには、Flex インストールディレクトリの下の "bin" ディレクトリから asdoc ユーティリティを呼び出します。たとえば、"bin" ディレクトリから、次のコマンドを入力して Flex Button クラスの出力を作成します。

asdoc -source-path C:¥flex¥frameworks¥source 
    -doc-classes mx.controls.Button 
    -main-title "Flex API Documentation" 
    -window-title "Flex API Documentation" 
    -output flex-framework-asdoc

この例では、Button クラスのソースコードは "C:¥flex¥frameworks¥source¥mx¥controls" ディレクトリにあります。出力は "C:¥flex¥bin¥flex-framework-asdoc" ディレクトリに書き込まれます。

出力を表示するには、"C:¥flex¥bin¥flex-framework-asdoc¥index.html" を開きます。asdoc コマンドの実行の詳細については、ASDoc ツールの実行を参照してください。

Flex 2.01