| <html> |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| <link rel="stylesheet" href="../../../default_style.css" type="text/css"> |
| <link rel="stylesheet" href="../../../webtools/wtp.css" type="text/css"> |
| <title>Eclipse API Scanner</title> |
| </head> |
| <body> |
| <table width="100%" cellspacing="5" cellpadding="2" border="0"> |
| <tbody> |
| <tr> |
| <td width="60%" align="left"><font class="indextop">Eclipse API Scanner</font> |
| <br> |
| <font class="indexsub">Eclipse API Scanner</font></td><td width="40%"><img width="207" hspace="50" height="129" align="middle" src="../../../webtools/images/wtplogosmall.jpg"></td> |
| </tr> |
| </tbody> |
| </table> |
| <table width="100%" cellspacing="5" cellpadding="2" border="0"> |
| <col width="16"> |
| <col width="*"> |
| <tbody> |
| <tr> |
| <td valign="top" align="right"> </td><td valign="top"><em>Updated 2005-02-07</em></td> |
| </tr> |
| <tr> |
| <td valign="top" bgcolor="#0080c0" align="left" colspan="2"><b><font face="Arial,Helvetica" color="#ffffff">Introduction</font></b></td> |
| </tr> |
| <tr> |
| <td valign="top" align="right"> </td><td valign="top"> |
| <p> |
| 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 |
| <a href="http://dev.eclipse.org/viewcvs/index.cgi/*checkout*/releng.wtptools/api/api-usage-checking.html?rev=HEAD&cvsroot=WebTools_Project&content-type=text/html">here</a>, and the design document |
| <a href="http://dev.eclipse.org/viewcvs/index.cgi/*checkout*/releng.wtptools/api/api-usage-checking-design.html?rev=HEAD&cvsroot=WebTools_Project&content-type=text/html">here</a>. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top" align="right"> </td><td valign="top"> |
| <p></p> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top" bgcolor="#0080c0" align="left" colspan="2"><b><font face="Arial,Helvetica" color="#ffffff">Downloading and running the Eclipse API scanner</font></b></td> |
| </tr> |
| <tr> |
| <td valign="top" align="right"> </td><td valign="top"> |
| <p> |
| You can get the latest version of the Eclipse API scanner |
| <a href="http://www.eclipse.org/downloads/download.php?file=/webtools/downloads/wtp-apiscanner.zip">here</a>. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top" align="right"> </td><td valign="top"> |
| <p> |
| The previous version of the Eclipse API scanner is available |
| <a href="http://www.eclipse.org/downloads/download.php?file=/webtools/downloads/apiscanner.zip">here</a>. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top" align="right"> </td><td valign="top"> |
| <p> |
| The source of the Eclipse API scanner is also available in |
| <a href="http://dev.eclipse.org/viewcvs/index.cgi/releng.wtptools/api/?cvsroot=WebTools_Project">CVS</a>. |
| Check out the |
| <b>org.eclipse.wtp.releng.tools.component.core</b> project and the |
| <b>org.eclipse.wtp.releng.tools.component.ui</b> project. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td valign="top" bgcolor="#0080c0" align="left" colspan="2"><b><font face="Arial,Helvetica" color="#ffffff">Running the Eclipse API scanner within Eclipse</font></b></td> |
| </tr> |
| <tr> |
| <td valign="top" align="right"> </td><td valign="top"> |
| <p> |
| 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. |
| <ol> |
| |
| <li>Download the latest |
| <a href="http://www.eclipse.org/downloads/download.php?file=/webtools/downloads/wtp-apiscanner.zip">Eclipse API scanner</a> |
| and unzip it on top of your Eclipse driver.</li> |
| |
| <li>Start Eclipse.</li> |
| |
| <li>Go to preference and make sure your target platform is correct.</li> |
| |
| <li>Load your plug-ins into the workspace.</li> |
| |
| <li>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.</li> |
| |
| <li>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. |
| <p> |
| <img src="./figure01.gif"></p> |
| |
| </li> |
| |
| <li>Right click on the same component.xml file again > API > Scan |
| for Missing javadoc.</li> |
| |
| <li>After the action completes, the Javadoc coverage report opens in a browser. |
| This report shows you plug-ins that have missing javadoc in them. |
| <p> |
| <img src="./figure02.gif"></p> |
| |
| </li> |
| |
| |
| |
| |
| </ol> |
| |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </body> |
| </html> |
