API Tools provides a number of tasks to integrate the tooling into your releng builds. They are available in the <code>org.eclipse.pde.api.tools bundle</code>. The jarred task code <code>apitooling-ant.jar</code> must be on the Ant classpath.

API Tools provides a number of tasks to integrate the tooling into your releng builds. They are available in the <code>org.eclipse.pde.api.tools bundle</code>. The jarred task code <code>apitooling-ant.jar</code> must be on the Ant classpath.

−

If you are running the tasks from an Eclipse target workspace, you must preface the task name with <code>apitooling.</code>. When running the ant task directly, just the task name is required. If the task name is incorrect, you will get the following error:

+

If you are running the tasks from an Eclipse target workspace, you must preface the task name with <code>apitooling.</code>. When running the ant task directly, just the task name is required. If the task name is incorrect, you will get the following error:<br/>

−

<pre>/target/Project/build.xml:15:<br/>

+

<code>/target/Project/build.xml:15:<br/>

Problem: failed to create task or type apideprecation<br/>

Problem: failed to create task or type apideprecation<br/>

−

Cause: The name is undefined.</pre>

+

Cause: The name is undefined.</code>

For documentation on task parameters and results see our [http://help.eclipse.org/helios/index.jsp?nav=/4_3_0 official documentation].

For documentation on task parameters and results see our [http://help.eclipse.org/helios/index.jsp?nav=/4_3_0 official documentation].

+

+

There are [[#Examples|example ant build files]] at the bottom of this page.

== Analysis Task==

== Analysis Task==

Revision as of 15:03, 24 November 2010

API Tools provides a number of tasks to integrate the tooling into your releng builds. They are available in the org.eclipse.pde.api.tools bundle. The jarred task code apitooling-ant.jar must be on the Ant classpath.

If you are running the tasks from an Eclipse target workspace, you must preface the task name with apitooling.. When running the ant task directly, just the task name is required. If the task name is incorrect, you will get the following error:/target/Project/build.xml:15:
Problem: failed to create task or type apideprecation
Cause: The name is undefined.

Analysis Task

This task runs a complete API analysis of an API profile relative to a baseline - including API use, binary compatibility, and bundle version number validation. The profile is the current state of a product under development. The profile is compared to an API baseline for binary compatibility (usually the previous release of a product).

The analysis does not include @since tag validation as all verification is performed on binary class files (source is not analyzed).

Analysis Report Conversion - The report conversion task converts the XML reports created by the Analysis Ant task into an HTML report.

API Deprecation Task

This task runs a complete API analysis of an API profile relative to a baseline - looking only for members (classes, fields, methods) that have been deprecated / un-deprecated. The profile is the current state of a product under development. The profile is compared to an API baseline for deprecation changes (usually the previous release of a product).

File Generation Task

This task runs to generate all files required by API Tooling inside a binary bundle. This task is run during the Eclipse builds or during the bundle export for all projects that have an API Tooling nature.