Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
<head>
  <meta name="copyright"
 content="Copyright (c) IBM Corporation and others 2008, 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page.">
  <meta http-equiv="Content-Type"
 content="text/html; charset=ISO-8859-1">
  <meta http-equiv="Content-Style-Type" content="text/css">
  <link rel="STYLESHEET" href="../../../book.css" type="text/css">
  <title>API Tools Setup Wizard</title>
</head>
<body>
<h1>API Tools Setup Wizard</h1>
<p>Before any plug-in project can make use of API Tools it must first be set up to use the tooling, which can be done using the API Tools setup wizard.</p> 
<p>
To activate the wizard use the following steps:</p>
<ol>
<li>Open the context menu on a plug-in project and select <strong><a href="../../actions/ref-pdetools.htm">PDE Tools</a></strong></li>
<li>On the resulting fly-out menu select <strong><a href="../actions/ref-apitooling-setup-action.htm">API Tools Setup...</a></strong></li>
</ol>
<table border="1" cellspacing="0" cellpadding= "5" width="100%">
  <thead>
    <tr>
      <th rowspan="1" colspan="1" width="20%"> <p> Option </p></th>
      <th rowspan="1" colspan="1"> <p> Description </p></th>
      <th rowspan="1" colspan="1" width="5%"> <p> Default </p></th>
    </tr>
  </thead>
  <tbody>
  	<tr>
      <td rowspan="1" colspan="1" valign="top" align="left">Choose a project</td>
      <td rowspan="1" colspan="1" valign="top" align="left">This text field allows you to filter the current list of projects by their name. Where '*' matches anything and '?' matches any character</td>
      <td rowspan="1" colspan="1" valign="top" align="left">Empty</td>
    </tr>
    <tr>
      <td rowspan="1" colspan="1" valign="top" align="left">Projects</td>
      <td rowspan="1" colspan="1" valign="top" align="left">This list contains all of the projects in the current workspace that can be set up to use API Tools. To be available to be converted a project must be a Java plug-in project.</td>
      <td rowspan="1" colspan="1" valign="top" align="left">&nbsp;</td>
    </tr>
    <tr>
      <td colspan="1" valign="top" align="left">Select All</td>
      <td colspan="1" valign="top" align="left">Selects all of the projects in the list.</td>
      <td colspan="1" valign="top" align="left">&nbsp;</td>
    </tr>
    <tr>
      <td colspan="1" valign="top" align="left">Deselect All</td>
      <td colspan="1" valign="top" align="left">Deselect all of the projects in the list.</td>
      <td colspan="1" valign="top" align="left">&nbsp;</td>
    </tr>
    <tr>
      <td colspan="1" valign="top" align="left">Delete component.xml after update is complete</td>
      <td colspan="1" valign="top" align="left"><p>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 Tools to describe the API of your plug-in.</p>
      <p>If a component.xml file is found it will be used by the setup wizard to add <a href="../api_javadoc_tags.htm"><strong>API restrictions</strong></a> (Javadoc tags) to the corresponding source files in your plug-in. All proposed changes can be viewed on the preview page for the wizard.</p></td>
      <td colspan="1" valign="top" align="center">On</td>
    </tr>
  </tbody>
</table>
<p>
The first page of the wizard allows you to select projects and set additional options.
</p>
<p>
<img src="../images/api-setup-wizard.png" alt="API Tools setup wizard page 1">
</p>
<p>
On the preview page you can see all of the changes that will be made to the project and any source files.
</p>
<p>
<img src="../images/api-setup-wizard-preview.png" alt="API Tools setup preview page">
</p>
<br>
<p> <img border="0" src="../../../images/ngrelt.png" alt="Related tasks" > </p>
<p> 
<a href="../../../tasks/api_tooling_setup.htm">Setting up API Tools</a>
</p>
<p><img src="../../../images/ngrelr.png" alt="Related reference" border="0"></p>
<p>
<a href="../actions/ref-apitooling-setup-action.htm">API Tools Setup Action</a><br>
<a href="../../actions/ref-pdetools.htm">PDE Tools Menu</a>
</p>

</body>
</html>
New to GrepCode? Check out our FAQ X