API 使用报告转换 Ant 任务

用途

此任务将 apitooling.apiuse Ant 任务所创建的 XML 报告转换为 HTML 文件。 HTML 报告将按生成了引用的捆绑软件(即,其中包含所引用的 API/类型的捆绑软件)来组织引用。

用法

描述

Ant 任务的名称为 apitooling.apiuse_reportconversion。 要使用 JAR 文件 apitooling-ant.jar,此文件必须在 Ant 类路径上。

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

参数

属性 描述 是否必需
xmlfiles 此属性指定要转换的 XML 文件所在的位置。

使用绝对路径来指定此位置。
是
htmlfiles 此属性指定要生成的 HTML 文件所在的位置。

使用绝对路径来指定此位置。
是
xsltfile 此属性指定要用来按期望顺序生成引用详细信息页面的 XSLT 文件所在的位置。

JAR 文件 apitooling-ant.jar 中提供了缺省 XSLT 文件。

使用绝对路径来指定此位置。
否
filterpatterns 此属性指定正则表达式模式的逗号分隔列表,这些模式用于在最终报告中修剪源自相匹配名称模式的引用。

该模式必须是按此处定义的格式正确的正则表达式。
否
tofilterpatterns 此属性指定正则表达式模式的逗号分隔列表,这些模式用于在最终报告中修剪对于相匹配名称模式的引用。

该模式必须是按此处定义的格式正确的正则表达式。
否
debug 设置调试值。

此属性的值可为: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 任务