API Use Report Conversion Ant Task

Purpose

This task converts the XML report created by the apitooling.apiuse Ant task into HTML files. The HTML report will organize the references by the bundle that produced them (i.e. the bundle that contains the api/type being referenced).

Usage

Description

The name of the Ant task is: apitooling.apiuse_reportconversion. To be used, the jar file apitooling-ant.jar has to be on the Ant classpath.

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

Parameters

Attribute Description Required
xmlfiles This attribute specifies the location of the xml files to convert.

The location is specified using an absolute path.
Yes
htmlfiles This attribute specifies the location of the html files to generate.

The location is specified using an absolute path.
Yes
xsltfile This attribute specifies the location of an XSLT file to be used to generate the reference details pages in a desired ordering.

A default XSLT file is available in the apitooling-ant.jar JAR file.

The location is specified using an absolute path.
No
filterpatterns This attribute specifies a comma separated listing of regular expression patterns used to prune references from matching name patterns from the final report.

The pattern must be a well-formatted regular expression as defined here.
No
tofilterpatterns This attribute specifies a comma separated listing of regular expression patterns used to prune references to matching name patterns from the final report.

The pattern must be a well-formatted regular expression as defined here.
No
debug Set the debug value.

The possible values are: true, false
Default is false.
No

Examples

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

 />

This will run the task creating *.html files inside the folder /eclipse/apiuse-both/HTML corresponding to the folder structure of the XML file location

If debug is enabled, some debug tracing will show up in the Ant console.

Related reference

API Consumer Use Report Conversion Ant Task
Analysis Ant Task
File Generation Ant Task
API Use Ant Task
API Freeze Ant Task
API Deprecation Ant Task
API Deprecation Report Conversion Ant Task
Analysis Report Conversion Ant Task