This document summarizes the usage of the Eclipse API scanner. The goal of the Eclipse API scanner is to identify any internal API references in any Eclipse-based products. You can view the requirements document here, and the design document here.

You can get the latest version of the Eclipse API scanner here.

The previous version of the Eclipse API scanner is available here.

The source of the Eclipse API scanner is also available in CVS. Check out the org.eclipse.wtp.releng.tools.component.core project and the org.eclipse.wtp.releng.tools.component.ui project.

The Eclipse API scanner is available as two Eclipse plug-ins. Therefore, you can overlay them on top of an Eclipse driver and use them to scan you APIs for violations, javadoc coverage and etc.

1. Download the latest Eclipse API scanner and unzip it on top of your Eclipse driver.
2. Start Eclipse.
3. Go to preference and make sure your target platform is correct.
4. Load your plug-ins into the workspace.
5. Right click on a component.xml file > API > Scan for API violation. It may take a few minutes when you run this action for the first time. This is because the scanner needs to parse the APIs for your target platform. Subsequence runs should be faster. Note that if you change your target platform, you will get the same delay again.
6. After the action completes, the API violation report opens in a browser. This report shows you all the API violations for plug-ins in the selected compoennt.

   

7. Right click on the same component.xml file again > API > Scan for Missing javadoc.
8. After the action completes, the Javadoc coverage report opens in a browser. This report shows you plug-ins that have missing javadoc in them.