Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

PDE/API Tools/Tasks

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

Copyright © Eclipse Foundation, Inc. All Rights Reserved.