|
1
|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head>
|
|
|
2 |
<title>CodeScanner preferences</title>
|
|
|
3 |
<link rel="StyleSheet" href="../book.css" type="text/css"/>
|
|
|
4 |
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
|
|
|
5 |
</head>
|
|
|
6 |
<body>
|
|
|
7 |
<div class="Head1">
|
|
|
8 |
<h2>CodeScanner preferences </h2>
|
|
|
9 |
</div>
|
|
|
10 |
<p>Use the <img src="images/command_link.png" width="16" height="12" border="0" alt="" /> <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=com.nokia.carbide.cpp.codescanner.ui.CSPreferencePage)")'>
|
|
|
11 |
CodeScanner</a> <b>General</b> page in the <b>Preferences</b> window (Figure 1) or the project's <a href="pref_codescanner_01.htm#cs_Projects">properties</a> window (Figure 2) to define where CodeScanner should output its generated report files and the format. You can also export and import Codescanner configuration files to enable sharing file types and rule sets across projects and programming teams.</p>
|
|
|
12 |
<p align="center"><img src="images/pref_cs_output.png" width="705" height="603" alt="" /></p>
|
|
|
13 |
<p align="center" class="figure">Figure 1. CodeScanner global settings </p>
|
|
|
14 |
<table width="700"
|
|
|
15 |
border="0" cellpadding="2" cellspacing="0">
|
|
|
16 |
<tr valign="top"><th width="198" class="Cell">Name</th>
|
|
|
17 |
<th width="492" class="Cell">Description</th>
|
|
|
18 |
</tr>
|
|
|
19 |
<tr valign="top">
|
|
|
20 |
<td class="Cell"><b>Configure Project Specific Settings... </b></td>
|
|
|
21 |
<td class="Cell"><p>Click to open the project <b>Properties</b> window and configure CodeScanner for that specific project. </p>
|
|
|
22 |
<p class="note"><b>NOTE</b> Only visible in the global CodeScanner preference panels. This also applies to the File Filters and Rules pages </p></td>
|
|
|
23 |
</tr>
|
|
|
24 |
<tr valign="top">
|
|
|
25 |
<td class="Cell"><b>CodeScanner directory </b></td>
|
|
|
26 |
<td class="Cell"><p>Type the path, or click <b>Browse</b> to locate codescanner.exe.</p></td>
|
|
|
27 |
</tr>
|
|
|
28 |
<tr valign="top">
|
|
|
29 |
<td class="Cell"><b>Generate HTML report </b></td>
|
|
|
30 |
<td class="Cell">Activate to generate reports in HTML format. Reports are stored in the Reports directory and can be viewed using a browser. </td>
|
|
|
31 |
</tr>
|
|
|
32 |
<tr valign="top">
|
|
|
33 |
<td class="Cell"><b>Generate XML report </b></td>
|
|
|
34 |
<td class="Cell">Activate to generate reports in XML format. Reports are stored in the Reports directory and can be viewed using a browser. </td>
|
|
|
35 |
</tr>
|
|
|
36 |
<tr valign="top">
|
|
|
37 |
<td class="Cell"><b>Reports directory </b></td>
|
|
|
38 |
<td class="Cell">Type the path, or click Browse to set the location the generated report files are stored. </td>
|
|
|
39 |
</tr>
|
|
|
40 |
<tr valign="top">
|
|
|
41 |
<td class="Cell"><strong>Enable Knowledge Base Scanning </strong></td>
|
|
|
42 |
<td class="Cell"><p>If enabled, CodeScanner will scan code and detect possible API issues related to a specific SDK, for example when porting to a new Touch UI SDK. For each SDK, specific porting information is defined as a set of rules specified in XML files. CodeScanner will import the rules and add them to the existing set of CodeScanner rules to be used during scanning operations. The results will be displayed in the <strong>Console</strong> view and as information markers in source code.</p>
|
|
|
43 |
<p>Click on an information marker or right-click on marker and select <strong>Quick Fix</strong> to display more information. Details of a CodeScanner/knowledge base marker are shown in a contextual help dialog when the mouse hovers over a particular marker. Each Quick Fix related information has an icon image.</p>
|
|
|
44 |
<p> A light bulb icon indicates a link to an external reference, which can be accessed by double-clicking.<br />
|
|
|
45 |
A green dot icon means there is no external reference.<br />
|
|
|
46 |
<br />
|
|
|
47 |
To show information markers in the Problems view make sure that <strong>Show > Show All</strong> is selected in the View Menu (upside down triangle icon) in the Problems view. Right-click on a marker and select View More Information or Quick Fix for additional information. Click <strong>Reference>></strong> link button for additional information.</p></td>
|
|
|
48 |
</tr>
|
|
|
49 |
<tr valign="top">
|
|
|
50 |
<td class="Cell"><b>Import Settings... </b></td>
|
|
|
51 |
<td class="Cell">Click to import a CodeScanner settings file.</td>
|
|
|
52 |
</tr>
|
|
|
53 |
<tr valign="top">
|
|
|
54 |
<td class="Cell"><b>Export Settings... </b></td>
|
|
|
55 |
<td class="Cell">Click to export a CodeScanner settings file of the current configuration settings in XML format. Export your settings to enable you to add <a href="customizing_cs.htm">custom rules</a> to the file.</td>
|
|
|
56 |
</tr>
|
|
|
57 |
<tr valign="top">
|
|
|
58 |
<td class="Cell"><strong>Restore Defaults </strong></td>
|
|
|
59 |
<td class="Cell">Click to restore to system defaults. CodeScanner directory setting will be updated to current path of CodeScanner executable. Other settings in the General tab will be cleared, including the Reports directory.</td>
|
|
|
60 |
</tr>
|
|
|
61 |
</table>
|
|
|
62 |
<p align="center"><img src="images/quick_fix.png" alt="quick fix" width="242" height="247" /></p>
|
|
|
63 |
<p align="center" class="figure">Figure 2. Quick Fix Command for CodeScanner Information Marker </p>
|
|
|
64 |
<p align="center"><img src="images/info_marker.png" alt="kb marker" width="633" height="456" /></p>
|
|
|
65 |
<p align="center" class="figure">Figure 3. Information Marker for CodeScanner Result</p>
|
|
|
66 |
<p>The CodeScanner plug-in supports a named extension point named "com.carbide.cpp.codescanner.rules". Other plugins can contribute CodeScanner rules by adding this extension point to the plugin.xml file and specifying the plugin-relative location of the rules xml files in the location element of this extension.</p>
|
|
|
67 |
<p><br />
|
|
|
68 |
For example:</p>
|
|
|
69 |
<p class="listing"><plugin><br />
|
|
|
70 |
<extension
|
|
|
71 |
point="com.carbide.cpp.codescanner.rules"><br />
|
|
|
72 |
<ruleSet<br />
|
|
|
73 |
name="Touch SDK"<br />
|
|
|
74 |
location="data/rules"<br />
|
|
|
75 |
/><br />
|
|
|
76 |
</extension><br />
|
|
|
77 |
</plugin></p>
|
|
|
78 |
<p>When the "Enable Knowledge Base Scanning" option is enabled, CodeScanner will locate plugins using this extension point and then read the rules in the xml files. Plugins that contain SDK information can be updated by using the Software Updates feature in the Help menu. </p>
|
|
|
79 |
<p>In the Express edition of Carbide.c++, the CodeScanner preference page is diasbled. In the Express version, when you select the <strong>Run CodeScanner</strong> command, CodeScanner will read the rules using the KnowledgeBase extension point and perform scanning ONLY with these rules (existing CodeScanner rules will be exlcuded).</p>
|
|
|
80 |
<p class="note"><strong>NOTE</strong> If you install a newer version of Carbide over an existing workspace, you may receive an error that CodeScanner cannot be found when trying to run CodeScanner. If this occurs, ensure that the CodeScanner directory is updated in both the CodeScanner global preference panel and the project specific CodeScanner panel.<br />
|
|
|
81 |
Example directory: C:\Program Files\Nokia\Carbide.c++ v2\plugins\com.nokia.carbide.cpp.codescanner_2.0.0.002_2008<em>xxxxxxxx</em>\Tools</p>
|
|
|
82 |
<h3><a name="cs_Projects" id="cs_Projects"></a>CodeScanner for projects </h3>
|
|
|
83 |
<p>CodeScanner options can also be set at the project level. Right-click the project and choose <strong>Properties</strong>, then select the <strong>Carbide.c++ > Carbide CodeScanner</strong> element in the properties list. Click a tab to view the appropriate page and set its options. </p>
|
|
|
84 |
<p align="center"><img src="images/proj_cs_output.png" width="705" height="599" alt="" /></p>
|
|
|
85 |
<p align="center" class="figure">Figure 4. CodeScanner project settings </p>
|
|
|
86 |
<p align="left">CodeScanner options specific to the project. </p>
|
|
|
87 |
<table width="700"
|
|
|
88 |
border="0" cellpadding="2" cellspacing="0">
|
|
|
89 |
<tr valign="top">
|
|
|
90 |
<th width="203" class="Cell">Name</th>
|
|
|
91 |
<th width="487" class="Cell">Description</th>
|
|
|
92 |
</tr>
|
|
|
93 |
<tr valign="top">
|
|
|
94 |
<td class="Cell"><strong>Enable Project Specific Settings </strong></td>
|
|
|
95 |
<td class="Cell">Activate to set project specific CodeScanner settings. By default a project in the workspace uses the global CodeScanner settings unless this option is activated. </td>
|
|
|
96 |
</tr>
|
|
|
97 |
<tr valign="top">
|
|
|
98 |
<td class="Cell"><b>Configure Workspace Settings... </b></td>
|
|
|
99 |
<td class="Cell"><p>Click to open the <b>Preferences</b> window and configure CodeScanner for the workspace. </p>
|
|
|
100 |
<p class="note"><b>NOTE</b> Only visible in the project CodeScanner property panels. </p></td>
|
|
|
101 |
</tr>
|
|
|
102 |
<tr valign="top">
|
|
|
103 |
<td class="Cell"><strong>Enable Knowledge Base Scanning</strong></td>
|
|
|
104 |
<td class="Cell">If enabled, CodeScanner will scan code and detect possible porting issues related to a specific SDK. For each SDK, specific porting information is defined as a set of rules specified in XML files. CodeScanner will import the rules and add them to the existing set of CodeScanner rules to be used during scanning operations. The results will be displayed in the <strong>Problems</strong> view as information markers pointing to source code locations. </td>
|
|
|
105 |
</tr>
|
|
|
106 |
<tr valign="top">
|
|
|
107 |
<td class="Cell"><b>Scan project automatically </b></td>
|
|
|
108 |
<td class="Cell">Activate to automatically run CodeScanner every time you build the project. </td>
|
|
|
109 |
</tr>
|
|
|
110 |
</table>
|
|
|
111 |
<h5>Other references</h5>
|
|
|
112 |
<ul><li><a href="pref_codescanner_02.htm">CodeScanner File Filters</a></li>
|
|
|
113 |
<li><a href="pref_codescanner_03.htm">CodeScanner Rules</a></li>
|
|
|
114 |
</ul>
|
|
|
115 |
<div id="footer">Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. <br>License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a></div>
|
|
|
116 |
</body>
|
|
|
117 |
</html>
|
|
|
118 |
|