Jump to: navigation, search

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

< PDE‎ | API Tools
Line 11: Line 11:
 
The analysis does not include @since tag validation as all verification is performed on binary class files (source is not analyzed).  
 
The analysis does not include @since tag validation as all verification is performed on binary class files (source is not analyzed).  
  
''' 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 Analysis Report Conversion] - The report conversion task converts the XML reports created by the Analysis Ant task into an HTML report.  
 
+
[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 ==
Line 22: Line 18:
  
  
 
+
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/apifreeze-reportconversion-ant-task.htm API Freeze Report Conversion] - The report conversion task converts the XML reports created by the API Freeze Ant task into an HTML report.
''' API Freeze Report Conversion '''
+
 
+
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/apifreeze-reportconversion-ant-task.htm Official Documentation]
+
  
 
== API Deprecation ==
 
== API Deprecation ==
Line 31: Line 24:
 
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/deprecation-ant-task.htm Official Documentation]
 
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/deprecation-ant-task.htm Official Documentation]
  
''' API Deprecation Report Conversion '''
+
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/deprecation-reportconversion-ant-task.htm API Deprecation Report Conversion] - The report conversion task converts the XML reports created by the API Deprecation Ant task into an HTML report.
 
+
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/deprecation-reportconversion-ant-task.htm Official Documentation]
+
  
 
== API Use ==
 
== API Use ==
Line 39: Line 30:
 
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/apiuse-ant-task.htm Official Documentation]
 
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/apiuse-ant-task.htm Official Documentation]
  
''' API Use Report Conversion '''
 
  
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/apiuse-reportconversion-ant-task.htm Official Documentation]
+
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/apiuse-reportconversion-ant-task.htm API Use Report Conversion] - The report conversion task converts the XML reports created by the API Use Ant task into an HTML report.
  
 
== API Use Migration ==
 
== API Use Migration ==
Line 47: Line 37:
 
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/apimigration-ant-task.htm Official Documentation]
 
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/apimigration-ant-task.htm Official Documentation]
  
''' API Use Migration Report Conversion '''
 
  
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/apimigration-reportconversion-ant-task.htm Official Documentation]
+
[http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks/apimigration-reportconversion-ant-task.htm API Use Migration Report Conversion] - The report conversion task converts the XML reports created by the API Use Migration Ant task into an HTML report.
  
 
== File Generation ==
 
== File Generation ==

Revision as of 11:56, 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.

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 - The report conversion task converts the XML reports created by the Analysis Ant task into an HTML report.

API Freeze

Official Documentation


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

API Deprecation

Official Documentation

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

API Use

Official Documentation


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

API Use Migration

Official Documentation


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

File Generation

Official Documentation