Flex 2 アプリケーションの構築とデプロイ > Flex アプリケーションの構築 > ASDoc の使用 > ASDoc ツールの実行

ASDoc ツールの実行

オプション doc-classes、doc-sources、doc-namespaces を使用して、asdoc コマンドによって処理されるクラスのリストを指定します。doc-classes および doc-namespaces オプションでは、source-path オプションを指定して、ファイルのルートディレクトリを指定する必要があります。

次のように、doc-classes オプションを使用してクラスまたはクラスのリストを指定する方法がもっとも基本的な例です。

asdoc -source-path . -doc-classes comps.GraphingWidget comps.GraphingWidgetTwo

この例では、クラスを "comps¥GraphingWidget.as" と "comps¥GraphingWidgetTwo.as" に置く必要があります。ここで、comps は、asdoc コマンドの実行元のディレクトリのサブディレクトリです。doc-classes オプションの引数は、クラスのパッケージ名に対応するドット表記を使用します。

クラスが現在のディレクトリにない場合は、source-path オプションを使用してそのディレクトリを指定します。たとえば、2 つの入力クラスがディレクトリ "C:¥flex¥class_dir¥comps" にある場合は、次のコマンドラインを使用して asdoc を呼び出します。

asdoc -source-path C:¥flex¥class_dir -doc-classes comps.GraphingWidget comps.GraphingWidgetTwo

doc-sources オプションを使用してソースクラスを指定することもできます。このオプションによって、asdoc はディレクトリを再帰的に検索します。次のコマンドラインは、現在のディレクトリとそのサブディレクトリのすべてのクラスの出力を生成します。

asdoc -source-path . -doc-sources .

doc-namespaces オプションを使用して、名前空間を入力として指定できます。次のコマンドラインでは、コアフレームワークのすべてのクラスが文書化されます。

asdoc -source-path frameworks 
    -namespace http://framework frameworks/core-framework-manifest.xml 
    -doc-namespaces http://framework

クラスの除外

doc-classes、doc-sources、および doc-namespaces オプションによって指定されるクラスは、次の例外を除いてすべて文書化されます。

次の例では、2 つのクラス comps¥PageWidget および comps¥ScreenWidget.as を除き、現在のディレクトリとそのサブディレクトリのすべてのクラスの出力を生成します。

asdoc -source-path . -doc-sources . -exclude-classes comps.PageWidget comps.ScreenWidget

除外されたクラスも、その他のすべての入力クラスとともにコンパイルされます。そのクラスの内容は出力で抑制されるだけです。

exclude-dependencies オプションを true に設定すると、クラスのコンパイル時に検出される依存クラスは文書化されません。デフォルト値は false です。つまり、通常は、指定されたクラスとともにコンパイルされるすべてのクラスが文書化されます。

たとえば、doc-classes オプションを使用してクラス A を指定します。クラス A がクラス B をインポートすると、クラス A とクラス B の両方が文書化されます。

asdoc コマンドのオプション

asdoc コマンドのオプションは、mxmlc および compc オプションと同様に機能します。mxmlc と comp の詳細については、Flex コンパイラの使用を参照してください。

次の表に、asdoc コマンドのオプションを示します。

オプション

内容
-doc-classes path-element [...]

ドキュメントのクラスのリスト。これらのクラスは、ソースパス上に存在する必要があります。これはデフォルトのオプションです。

このオプションは、compc コンポーネントコンパイラの -include-classes オプションと同様に機能します。詳細については、コンポーネントコンパイラの使用を参照してください。

-doc-namespaces uri manifest

クラスを文書化する必要がある URI のリスト。これらのクラスは、ソースパス上に存在する必要があります。

この名前空間のコンテンツを定義するマニフェストファイルの URI と格納場所を含める必要があります。

このオプションは、compc コンポーネントコンパイラの -include-namespaces オプションと同様に機能します。詳細については、コンポーネントコンパイラの使用を参照してください。

-doc-sources path-element [...]

文書化する必要があるファイルのリスト。ディレクトリ名がリストにある場合は、再帰的に検索されます。

このオプションは、compc コンポーネントコンパイラの -include-sources オプションと同様に機能します。詳細については、コンポーネントコンパイラの使用を参照してください。

-exclude-classes string

文書化してはならないクラスのリスト。個別のクラス名を指定する必要があります。また、クラスの ASDoc コメントに @private タグが含まれる場合は、そのクラスは文書化されません。

-exclude-dependencies true|false

コンパイラによって検出されたすべての依存関係を文書化するかどうか。true の場合は、入力クラスの依存関係は文書化されません。

デフォルト値は false です。
-footer string

出力されるドキュメントの HTML ページの下部に表示されるテキスト。
-left-frameset-width int

ドキュメントの左側のフレームセットの幅を変更する整数。パッケージ名の長さに合わせてこのサイズを変更できます。

デフォルト値は 210 ピクセルです。
-main-title "string"

出力されるドキュメントの HTML ページの上部に表示されるテキスト。

デフォルト値は "API Documentation" です。

-output string

生成されるドキュメントの出力ディレクトリ。デフォルト値は "asdoc-output" です。
-package name "description"

ドキュメント内のパッケージの説明に使用する記述。1 つまたは複数の package オプションを指定できます。

次の例では、2 つのパッケージの説明が出力に追加されます。

asdoc -doc-sources my_dir -output myDoc -package com.my.business "Contains business classes and interfaces" -package com.my.commands "Contains command base classes and interfaces"
-templates-path string

ASDoc テンプレートディレクトリへのパス。デフォルトは、ASDoc インストールディレクトリの下の "asdoc/templates" ディレクトリです。このディレクトリには、出力の生成に使用するすべての HTML、CSS、XSL、およびイメージファイルが含まれます。

-window-title "string"

出力されるドキュメントのブラウザウィンドウに表示されるテキスト。

デフォルト値は "API Documentation" です。

asdoc コマンドは、compc コンポーネントコンパイラの次のオプションも認識します。

詳細については、アプリケーションコンパイラの使用を参照してください。mxmlc および compc と同じコマンドラインおよび設定ファイルを ASDoc ツールで使用できるように、これ以外のすべてのアプリケーションコンパイラオプションは受け入れられますが、無視されます。

Flex 2.01