API Tooling Overview

The Plug-in Development Environment (PDE) provides a tooling to assist documentation and maintenance of APIs provided by plug-ins and OSGi bundles.

Some of the features include:

• Compatability Analysis : Identify binary compatibility issues relative to a previous version of a plug-in.
• API Restriction Tags : Javadoc tags are provided to explicitly define restrictions associated with types and members.
• Version Number Validation : Identify invalid plug-in version numbers relative to a previous version of a plug-in.
• Javadoc @since Tag Validation : Identify missing and invalid @since tags on types and members.
• API Leak Analysis : Identify API types and methods that leak non-API types.
• Quick Fixes : Quick fixes are provided to adjust plug-in versions and @since tags appropriately.
  

To get started, see API Tooling Setup.