オプション 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

コンパイル用として、SWC ファイルとして表されるライブラリファイルをアプリケーションが必要とする場合もあります。次の例では、-library-path オプションを使用して、SWC ファイルが格納されているディレクトリを指定します。

asdoc -source-path . -doc-classes myComponents.BlueButton  -library-path C:¥myLibs

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 オプションによって指定されるクラスは、次の例外を除いてすべて文書化されます。

• exclude-classes オプションを使用してクラスを指定した場合は、そのクラスは文書化されません。
• クラスの ASDoc コメントに @private タグが含まれる場合は、そのクラスは文書化されません。
• クラスが SWC で検出されると、そのクラスは文書化されません。

次の例では、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 コマンドのオプションを示します。

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

• -source-path
• -library-path
• -namespace
• -load-config
• -actionscript-file-encoding
• -help
• -advanced
• -benchmark
• -strict
• -warnings

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