| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html lang="en"> |
| <head> |
| <meta name="copyright" content="Copyright (c) IBM Corporation and others 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 Use Scans Preferences</title> |
| <script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"> </script> |
| </head> |
| <body> |
| <h1> API Use Scans Preferences </h1> |
| <p> The following preferences can be set using the <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.pde.api.tools.ui.apiusescan.prefpage)")'> <img src="PLUGINS_ROOT/org.eclipse.help/command_link.svg" alt="Opens the API Use Scans preference page"> <b>Plug-in Development > API Use Scans</b></a> preference page. </p> |
| <p>An API Use Scan is a list of references using the <a href="../ant-tasks/apiuse-ant-task.htm">ant task</a> or the <a href="../wizards/ref-api-use-dialog.htm">report tool</a>. The API Analysis builder checks that all references listed in the provided use scans still exist in your workspace projects. Any missing types, methods or fields will be reported as problems in the workspace based on your Error/Warning preference settings.</p> |
| <p> |
| <img src="../images/usescans-pref-page.png" alt="API use scans preference page"> |
| </p> |
| <br> |
| <table border="1" cellspacing="0" cellpadding= "5" width="100%"> |
| <thead> |
| <tr> |
| <th rowspan="1" colspan="1" width="30%"> <p> Option </p></th> |
| <th rowspan="1" colspan="1"> <p> Description </p></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td rowspan="1" colspan="1" valign="top" align="left">Select All</td> |
| <td rowspan="1" colspan="1" valign="top" align="left">Selects all use scan locations in the list. The API analysis builder will check all locations.</td> |
| </tr> |
| <tr> |
| <td rowspan="1" colspan="1" valign="top" align="left">Deselect All</td> |
| <td rowspan="1" colspan="1" valign="top" align="left">Deselects all use scan locations in the list. The API analysis builder will not check any locations.</td> |
| </tr> |
| <tr> |
| <td rowspan="1" colspan="1" valign="top" align="left">Add Directory...</td> |
| <td rowspan="1" colspan="1" valign="top" align="left">Adds a new use scan stored in a directory.</td> |
| </tr> |
| <tr> |
| <td rowspan="1" colspan="1" valign="top" align="left">Add Archive...</td> |
| <td rowspan="1" colspan="1" valign="top" align="left">Adds a new use scan stored in an archive file.</td> |
| </tr> |
| <tr> |
| <td rowspan="1" colspan="1" valign="top" align="left">Edit Location...</td> |
| <td rowspan="1" colspan="1" valign="top" align="left">Allows you to change the location of a use scan directory or archive.</td> |
| </tr> |
| <tr> |
| <td rowspan="1" colspan="1" valign="top" align="left">Remove</td> |
| <td rowspan="1" colspan="1" valign="top" align="left">Removes the selected use scans from the list.</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 class="related">Related references</h3> |
| <a href="../../../guide/tools/preference_pages/preferences.htm">PDE Preferences</a><br> |
| <a href="../ant-tasks/apiuse-ant-task.htm">API Use Scan Ant Task</a><br> |
| <a href="../wizards/ref-api-use-dialog.htm">API Use Scan Report Tool</a><br> |
| <a href="ref-errorswarnings.htm">API Errors and Warnings Preferences</a><br> |
| <a href="ref-baselines.htm">API Baselines Preferences</a> |
| </body> |
| </html> |
