Difference between revisions of "PDE/API Tools/Tasks"

From Eclipsepedia

< PDE‎ | API Tools
Jump to: navigation, search
Line 6: Line 6:
  
 
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/analysis-ant-task.htm Official Documentation]
 
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/analysis-ant-task.htm Official Documentation]
 +
 +
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 '''
 
''' Analysis Report Conversion '''
  
 
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/analysis-reportconversion-ant-task.htm Official Documentation]
 
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/analysis-reportconversion-ant-task.htm Official Documentation]
 +
 +
This task converts XML reports created by the apitooling.analysis Ant task into HTML files.
  
 
== API Freeze ==
 
== API Freeze ==
  
 
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/apifreeze-ant-task.htm Official Documentation]
 
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/apifreeze-ant-task.htm Official Documentation]
 +
 +
  
 
''' API Freeze Report Conversion '''
 
''' API Freeze Report Conversion '''

Revision as of 12:49, 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.

For documentation on task parameters and results see our official documentation.

Contents

Analysis

Official Documentation

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

Official Documentation

This task converts XML reports created by the apitooling.analysis Ant task into HTML files.

API Freeze

Official Documentation


API Freeze Report Conversion

Official Documentation

API Deprecation

Official Documentation

API Deprecation Report Conversion

Official Documentation

API Use

Official Documentation

API Use Report Conversion

Official Documentation

API Use Migration

Official Documentation

API Use Migration Report Conversion

Official Documentation

File Generation

Official Documentation