Jump to: navigation, search

Difference between revisions of "PDE/API Tools/User Guide"

< PDE‎ | API Tools
(New page: == Current State == API tooling is still under construction and currently lives in the PDE incubator project. This guide is intended to be an example of how we intend developers to use AP...)
 
(Configuring Bundles for API Tooling)
Line 5: Line 5:
 
API tooling bundles (plug-ins) are not avialable as binary downloads. You have to build the plug-ins yourself if you want to use them. See [http://wiki.eclipse.org/PDE_UI_Incubator_ApiTools#Getting_the_Source_Code Getting the Source Code] for help on getting and building the bundles.
 
API tooling bundles (plug-ins) are not avialable as binary downloads. You have to build the plug-ins yourself if you want to use them. See [http://wiki.eclipse.org/PDE_UI_Incubator_ApiTools#Getting_the_Source_Code Getting the Source Code] for help on getting and building the bundles.
  
== Configuring Bundles for API Tooling ==
+
== API Tooling Setup ==
  
 
API tooling provides a builder that reports API usage and binary compatibility errors in the workspace. You must configure bundles that you want API tooling to report errors on and you must define an API profile that can be used as an API baseline (i.e. workspace projects are compared to the baseline in order to report binary compatibility errors, missing @since tags, incorrect version numbers, etc.).
 
API tooling provides a builder that reports API usage and binary compatibility errors in the workspace. You must configure bundles that you want API tooling to report errors on and you must define an API profile that can be used as an API baseline (i.e. workspace projects are compared to the baseline in order to report binary compatibility errors, missing @since tags, incorrect version numbers, etc.).
 +
 +
<h4>Define an API Baseline</h4>
 +
 +
An API baseline defines the state you want to compare your development workspace bundles against for the purposes of binary compatibility, bundle version numbers, and @since tags. For example, if you are developing bundles for Eclipse 3.4, you will use Eclipse 3.3 as your baseline.
 +
 +
API profiles are managed on the '''Plug-in Development > API Profiles''' preference page. Here you can create, edit, and delete API profiles. You can select one profile as the 'default' profile - this is the profile that will be used as the baseline.
 +
 +
 +
 +
<h4>Configure Bundles for API Tooling</h4>

Revision as of 23:00, 7 January 2008

Current State

API tooling is still under construction and currently lives in the PDE incubator project. This guide is intended to be an example of how we intend developers to use API tooling rather than how it is used today. Some form of the tooling will be avilable in Eclipse 3.4, starting with the M5 milestone build.

API tooling bundles (plug-ins) are not avialable as binary downloads. You have to build the plug-ins yourself if you want to use them. See Getting the Source Code for help on getting and building the bundles.

API Tooling Setup

API tooling provides a builder that reports API usage and binary compatibility errors in the workspace. You must configure bundles that you want API tooling to report errors on and you must define an API profile that can be used as an API baseline (i.e. workspace projects are compared to the baseline in order to report binary compatibility errors, missing @since tags, incorrect version numbers, etc.).

Define an API Baseline

An API baseline defines the state you want to compare your development workspace bundles against for the purposes of binary compatibility, bundle version numbers, and @since tags. For example, if you are developing bundles for Eclipse 3.4, you will use Eclipse 3.3 as your baseline.

API profiles are managed on the Plug-in Development > API Profiles preference page. Here you can create, edit, and delete API profiles. You can select one profile as the 'default' profile - this is the profile that will be used as the baseline.


Configure Bundles for API Tooling