Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Mail Systems
Eclipse Documentation

How To Guides
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Problem Solutions
Privacy Policy




Eclipse Platform Plug-in Development Environment Guide
Previous Page Home Next Page

API Tooling Setup Wizard

Before any plug-in project can make use of API Tooling it must first be set up to use the tooling, which can be done using the API Tooling setup wizard.

To activate the wizard use the following steps:

  1. Open the context menu on a plug-in project and select PDE Tools
  2. On the resulting fly-out menu select API Tooling Setup...




Choose a project This text field allows you to filter the current list of projects by their name. Where '*' matches anything and '?' matches any character Empty
Projects This list contains all of the projects in the current workspace that can be set up to use API Tooling. To be available to be converted a project must be a Java plug-in project.  
Select All Selects all of the projects in the list.  
Deselect All Deselect all of the projects in the list.  
Delete component.xml after update is complete

This option will remove the component.xml file from your plug-in project when the setup is complete. A component.xml file was used prior to API Tooling to describe the API of your plug-in.

If a component.xml file is found it will be used by the setup wizard to add API restrictions (Javadoc tags) to the corresponding source files in your plug-in. All proposed changes can be viewed on the preview page for the wizard.


The first page of the wizard allows you to select projects and set additional options.

API Tooling setup wizard page 1

On the preview page you can see all of the changes that will be made to the project and any source files.

API Tooling setup preview page

Related tasks

Setting up API Tooling

Related reference

API Tooling Setup Action
PDE Tools Menu

  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire