API 使用レポート変換の Ant タスク

目的

このタスクは、apitooling.apiuse Ant タスクによって作成された XML レポートを HTML ファイルに変換します。HTML レポートは、それらを作成したバンドルによって参照を編成します (つまり、API/type を含むバンドルが参照されます)。

使用法

説明

Ant タスクの名前は、apitooling.apiuse_reportconversion です。 使用するには、jar ファイル apitooling-ant.jar が Ant クラスパス上になければなりません。

<apitooling.apiuse_reportconversion
	xmlfiles="..."
	htmlfiles="..."
	xsltfile="..."
	filterpatterns="..."
	tofilterpatterns="..."
	debug="..."
/>

パラメーター

属性 説明 必須
xmlfiles この属性は、変換する XML ファイルのロケーションを指定します。

ロケーションは、絶対パスを使用して指定します。
はい
htmlfiles この属性は、生成する HTML ファイルのロケーションを指定します。

ロケーションは、絶対パスを使用して指定します。
はい
xsltfile この属性は、参照の詳細ページを望ましい順序で生成するのに使用される XSLT ファイルのロケーションを指定します。

apitooling-ant.jar JAR ファイル内のデフォルトの XSLT ファイルを使用可能です。

ロケーションは、絶対パスを使用して指定します。
いいえ
filterpatterns この属性は、最終レポートからマッチング名パターンからの 参照を除去するのに使用する正規表現パターンのコンマ区切りリストを指定します。

このパターンは、ここで定義されるように、適切にフォーマット設定された正規表現でなければなりません。
いいえ
tofilterpatterns この属性は、最終レポートからマッチング名パターンへの 参照を除去するのに使用する正規表現パターンのコンマ区切りリストを指定します。

このパターンは、ここで定義されるように、適切にフォーマット設定された正規表現でなければなりません。
いいえ
デバッグ デバッグ値を設定します。

指定可能な値は、true、false です。
デフォルトは false です。
いいえ

サンプル

 <apitooling.apiuse_reportconversion
  xmlfiles="/eclipse/apiuse-both/XML"
  htmlfiles="/eclipse/apiuse-both/HTML"
  xsltfile="/eclipse/references.xsl"
  debug="true"

 />

これにより、XML ファイルのロケーションのフォルダー構造に対応する、フォルダー /eclipse/apiuse-both/HTML 内に *.html ファイルを作成するタスクが実行されます。

デバッグが使用可能である場合、いくつかのデバッグ・トレースが Ant コンソールに表示されます。

関連参照

API コンシューマー使用レポート変換の Ant タスク
分析の Ant タスク
ファイル生成の Ant タスク
API 使用の Ant タスク
API フリーズの Ant タスク
API 非推奨の Ant タスク
API 非推奨レポート変換の Ant タスク
分析レポート変換の Ant タスク