author | chpeckha |
Tue, 25 May 2010 13:19:07 -0500 | |
changeset 1398 | 53b756905916 |
parent 128 | c028612cc555 |
permissions | -rw-r--r-- |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
2 |
<title>Customizing CodeScanner Rules</title> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
3 |
<link rel="StyleSheet" href="../book.css" type="text/css"/> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
4 |
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
5 |
</head> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
6 |
<body> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
7 |
<div class="Head1"> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
8 |
<h2>Customizing CodeScanner Rules</h2> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
9 |
</div> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
10 |
<p> The CodeScanner command line tool currently accepts an XML configuration file, which controls scanning behavior, like the file types to ignore and which rules to apply. Using the elements contained here makes it possible to customize the scanning rules to include new rules unique to your development environment.</p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
11 |
<p>This page describes the format of CodeScanner config file (<span class="code">codescannerconfig.xml</span>), which is used for the following purposes: </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
12 |
<ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
13 |
<li>Controls scanning behavior of the CodeScanner command line tool</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
14 |
<li> Importing/exporting rules and file types from CodeScanner preference pages in Carbide.c++ IDE </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
15 |
</ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
16 |
<h2>CODESCANNERCONFIG.XML File</h2> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
17 |
<p>The CodeScanner config file is an XML formatted file created by CodeScanner when a scan is performed or when the CodeScaner preference settings are <a href="pref_codescanner_01.htm">exported</a>. The file contains the following elements: </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
18 |
<ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
19 |
<li><a href="#ARG_Element">Arguments</a> element – specifies the arguments to be passed to CodeScanner</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
20 |
<li><a href="#SRC_Element">Sources</a> element – specifies the file types to be ignored by CodeScanner</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
21 |
<li><a href="#SCRIPT_Element">Scripts</a> element – specifies the rules to be applied by CodeScanner</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
22 |
<li><a href="#SEV_Element">Severities</a> element – specifies the severity levels of rules to be applied by CodeScanner</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
23 |
<li><a href="#CAT_Element">Categories</a> element – specifies the categories of rules to be applied by CodeScanner</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
24 |
<li><a href="#RULE_Element">CustomRules</a> element – specifies user defined rules to be applied by CodeScanner</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
25 |
</ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
26 |
<h4><a name="ARG_Element" id="ARG_Element"></a>Arguments Element</h4> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
27 |
<p>Each Arguments element contains one or more of the following arguments: </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
28 |
<ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
29 |
<li><b>Input</b> element (<span class="code"><input></span>, <span class="code"></input></span>) – Specify an additional directory or file to scan. </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
30 |
<li><b>Outputformat</b> element (<span class="code"><outputformat></span>, <span class="code"></outputformat></span>) – Specify the output format(s) of the results generated by CodeScanner. Currently the following output formats are supported: |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
31 |
<ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
32 |
<li>html – generate HTML report</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
33 |
<li> xml – generate an XML report</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
34 |
<li> std – generate messages in standard console output</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
35 |
</ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
36 |
</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
37 |
<li><b>LXR</b> element (<span class="code"><lxr></span>, <span class="code"></lxr></span>) – Specify the URL to an LXR site. When this argument is present, CodeScanner generates links to the specified LXR site instead of the local file system. </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
38 |
<li><b>LXR version</b> element (<span class="code"><lxrversion></span>, <span class="code"></lxrversion></span>) – Specify the LXR version when generating links to an LXR site. </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
39 |
<li><b>Timestampedoutput</b> element (<span class="code"><timestampedoutput></span>, <span class="code"></timestampedoutput></span>) – Specify whether to generate results in a time-stamped output directory. Supported values are on and off. </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
40 |
</ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
41 |
<p>An example of an Arguments element: </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
42 |
<p class="listing"><arguments><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
43 |
<input>C:\Symbian\9.2\Epoc32\include</input><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
44 |
<input>C:\CodeScanner_Tests\includes</input> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
45 |
<lxr>http://s60lxr/source/</lxr> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
46 |
|
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
47 |
<lxrversion>S60_3_2_200736</lxrversion><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
48 |
<outputformat>html|std</outputformat> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
49 |
<timestampedoutput>on</timestampedoutput> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
50 |
</arguments> </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
51 |
<h4><a name="SRC_Element" id="ARG_Element2"></a>Sources Element</h4> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
52 |
<p>Each Sources element can contain one or more Excludes elements. </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
53 |
<ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
54 |
<li><b>Excludes</b> element (<span class="code"><excludes></span>, <span class="code"></excludes></span>) – Each Excludes element contains a string, which is a regular expression that specifies a file type to be ignored by CodeScanner. </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
55 |
</ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
56 |
<p>An example of a Sources element: </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
57 |
<p class="listing"><sources> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
58 |
<exclude>.*\.avi</exclude> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
59 |
<exclude>.*\.bmp</exclude> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
60 |
<exclude>.*\.jpg</exclude> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
61 |
<exclude>.*\\test\\.*</exclude> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
62 |
</sources> </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
63 |
<h4><a name="SCRIPT_Element" id="ARG_Element3"></a>Scripts Element</h4> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
64 |
<p>Each Scripts element can contain one or more Script elements, each of which corresponds to a CodeScanner script (each script applies a CodeScanner rule): </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
65 |
<ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
66 |
<li><b>Script</b> element The name of each Script element matches the name of the corresponding rule, e.g. baseconstruct, forbiddenwords, magicnumbers. Each Script element has the following attributes: |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
67 |
<ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
68 |
<li>enable (boolean) – specifies whether a script is enabled by CodeScanner</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
69 |
<li>severity (string) – specifies the severity level of a script</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
70 |
<li>category (string) – specifies the category of a script</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
71 |
</ul>In addition, certain script elements also have special child element or attribute: |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
72 |
</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
73 |
<ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
74 |
<li><b>wordsRE</b> element (<span class="code"><wordsRE></span>, <span class="code"></wordsRE></span>) – Specify the child element of the forbiddenwords script element. The wordsRE element contains a string, which is a regular expression that specifies the forbidden words detected by the forbiddenwords script.</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
75 |
<li><b>length</b> attribute – Attribute of the longlines script element. The length attribute is a string that specifies the maximum length of a line of code, beyond which the longlines script flags as a problem. </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
76 |
<li><b>LFunctionIgnoreRE</b> element (<span class="code"><LFunctionIgnoreRE></span>, <span class="code"></LFunctionIgnoreRE></span>) – Specify the child element of the LFunctionCantLeave script element. The LFunctionIgnoreRE element contains a string, which is a regular expression that specifies the L-functions to be ignored by the LFunctionCantLeave script when checking for L-functions inside cannot leave. </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
77 |
<li><b>cclassIgnoreRE</b> element (<span class="code"><cclassIgnoreRE></span>, <span class="code"></cclassIgnoreRE></span>) – Specify the child element of the missingcclass script element. The cclassIgnoreRE element contains a string, which is a regular expression that specifies the classes to be ignored by the missingcclass script when checking for C classes not inheriting from other C classes.</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
78 |
<li><b>openIgnoreRE</b> element (<span class="code"><openIgnoreRE></span>, <span class="code"></openIgnoreRE></span>) – Specify the child element of this open script element. The openIgnoreRE element contains a string, which is a regular expression that specifies the classes or objects to be ignored by the open script when checking for ignored return type from Open(). </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
79 |
<li><b>worryRE</b> element (<span class="code"><worryRE></span>, <span class="code"></ worryRE></span>) – Child element of the worryingcomments script element. The worryRE element contains a string, which is a regular expression that specifies the worrying comments detected by the worryingcomments script. </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
80 |
</ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
81 |
</ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
82 |
<p>Complete list of currently supported Script elements with default attributes: </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
83 |
<p class="listing"><scripts><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
84 |
<br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
85 |
<accessArrayElementWithoutCheck category="codereview" enable="true" severity="low"/><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
86 |
<accessArrayElementWithoutCheck2 category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
87 |
<activestart category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
88 |
<activestop category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
89 |
<arraypassing category="performance" enable="true" severity="medium"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
90 |
<arrayptrcleanup category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
91 |
<assertdebuginvariant category="codingstandards" enable="true" severity="low"/><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
92 |
<br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
93 |
<baddefines category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
94 |
<baseconstruct category="codereview" enable="true" severity="low"/><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
95 |
<br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
96 |
<callActiveObjectWithoutCheckingOrStopping category="codereview" enable="true" severity="low"/> <changenotification category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
97 |
<cleanup category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
98 |
<commentcode category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
99 |
<connect category="canpanic" enable="true" severity="high"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
100 |
<ConnectAndDontCloseMemberVariable category="functionality" enable="true" severity="medium"/> <constnames category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
101 |
<consttdescptr category="codingstandards" enable="true" severity="low"/> <br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
102 |
<controlornull category="canpanic" enable="true" severity="high"/> <br> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
103 |
<crepository category="other" enable="true" severity="low"/><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
104 |
<ctltargettype category="functionality" enable="true" severity="medium"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
105 |
<customizableicons category="other" enable="true" severity="low"><br> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
106 |
<iconsRE>iconA.bmp|iconB.svg|iconC</iconsRE> <br> |
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
107 |
</customizableicons><br> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
108 |
<br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
109 |
<debugrom category="performance" enable="true" severity="medium"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
110 |
<declarename category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
111 |
<deleteMemberVariable category="canpanic" enable="true" severity="high"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
112 |
<destructor category="canpanic" enable="true" severity="high"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
113 |
<doubleSemiColon category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
114 |
<driveletters category="codingstandards" enable="true" severity="low"/> <br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
115 |
<br /> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
116 |
<eikbuttons category="localisation" enable="true" severity="medium"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
117 |
<eikonenvstatic category="performance" enable="true" severity="medium"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
118 |
<enummembers category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
119 |
<enumnames category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
120 |
<exportinline category="functionality" enable="true" severity="medium"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
121 |
<exportpurevirtual category="functionality" enable="true" severity="medium"/> <br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
122 |
<br /> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
123 |
<flags category="other" enable="true" severity="low"/><br> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
124 |
<foff category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
125 |
<forbiddenwords category="codingstandards" enable="true" severity="low"> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
126 |
<wordsRE>Epoc|Nokia Mobile Phones|NMP|(^|\s)S60</wordsRE> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
127 |
</forbiddenwords><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
128 |
<forgottoputptroncleanupstack category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
129 |
<friend category="codereview" enable="true" severity="low"/> <br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
130 |
<br /> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
131 |
<goto category="codingstandards" enable="true" severity="low"/> <br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
132 |
<br /> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
133 |
<ifassignments category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
134 |
<ifpreprocessor category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
135 |
<inheritanceorder category="canpanic" enable="true" severity="high"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
136 |
<intleaves category="codereview" enable="true" severity="low"/> <br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
137 |
<br /> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
138 |
<jmp category="codingstandards" enable="true" severity="low"/> <br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
139 |
<br /> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
140 |
<leave category="canpanic" enable="true" severity="high"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
141 |
<LeaveNoError category="functionality" enable="true" severity="medium"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
142 |
<leavingoperators category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
143 |
<LFunctionCantLeave category="codereview" enable="true" severity="low"> <LFunctionIgnoreRE>RunL</LFunctionIgnoreRE> </LFunctionCantLeave> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
144 |
<longlines category="codingstandards" enable="true" length="160" severity="low"/> <br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
145 |
<br /> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
146 |
<magicnumbers category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
147 |
<mclassdestructor category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
148 |
<memberlc category="canpanic" enable="true" severity="high"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
149 |
<membervariablecallld category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
150 |
<missingcancel category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
151 |
<missingcclass category="canpanic" enable="true" severity="high"> <cclassIgnoreRE>CBase</cclassIgnoreRE> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
152 |
</missingcclass> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
153 |
<mmpsourcepath category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
154 |
<multilangrsc category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
155 |
<multipledeclarations category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
156 |
<multipleinheritance category="functionality" enable="true" severity="medium"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
157 |
<mydocs category="functionality" enable="true" severity="medium"/> <br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
158 |
<br /> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
159 |
<namespace category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
160 |
<newlreferences category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
161 |
<noleavetrap category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
162 |
<nonconsthbufc category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
163 |
<nonconsttdesc category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
164 |
<nonleavenew category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
165 |
<nonunicodeskins category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
166 |
<null category="codingstandards" enable="true" severity="low"/> <br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
167 |
<br /> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
168 |
<open category="canpanic" enable="true" severity="high"> <openIgnoreRE>RDesReadStream|RDesWriteStream</openIgnoreRE><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
169 |
</open> <br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
170 |
<br /> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
171 |
<pointertoarrays category="performance" enable="true" severity="medium"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
172 |
<pragmadisable category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
173 |
<pragmamessage category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
174 |
<pragmaother category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
175 |
<privateinheritance category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
176 |
<pushaddrvar category="canpanic" enable="true" severity="high"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
177 |
<pushmember category="canpanic" enable="true" severity="high"/> <br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
178 |
<br /> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
179 |
<readresource category="canpanic" enable="true" severity="high"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
180 |
<resourcenotoncleanupstack category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
181 |
<resourcesonheap category="codingstandards" enable="true" severity="low"/> <returndescriptoroutofscope category="canpanic" enable="true" severity="high"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
182 |
<rfs category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
183 |
<rssnames category="codereview" enable="true" severity="low"/> <br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
184 |
<br /> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
185 |
<stringliterals category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
186 |
<stringsinresourcefiles category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
187 |
<struct category="codingstandards" enable="true" severity="low"/> <br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
188 |
<br /> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
189 |
<tcclasses category="functionality" enable="true" severity="medium"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
190 |
<tclassdestructor category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
191 |
<todocomments category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
192 |
<trapcleanup category="panic" enable="true" severity="high"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
193 |
<trapeleave category="performance" enable="true" severity="medium"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
194 |
<traprunl category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
195 |
<trspassing category="functionality" enable="true" severity="medium"/> <br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
196 |
<br /> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
197 |
<uids category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
198 |
<uncompressedaif category="performance" enable="true" severity="medium"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
199 |
<uncompressedbmp category="performance" enable="true" severity="medium"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
200 |
<unicodesource category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
201 |
<userafter category="performance" enable="true" severity="medium"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
202 |
<userfree category="codereview" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
203 |
<userWaitForRequest category="codereview" enable="true" severity="low"/> <br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
204 |
<br /> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
205 |
<variablenames category="codingstandards" enable="true" severity="low"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
206 |
<voidparameter category="codingstandards" enable="true" severity="low"/> <br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
207 |
<br /> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
208 |
<worryingcomments category="codereview" enable="true" severity="low"> <worryRE>\!|\?|[Zz]{3}|kludge|workaround|\scrap|hack</worryRE> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
209 |
</worryingcomments><br /> |
36
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
210 |
<br /> |
131ddbe8aee4
added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
211 |
<span class="listing"></scripts> </span></p> |
69
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
212 |
<h4><a name="SEV_Element" id="ARG_Element4"></a>Severities Element</h4> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
213 |
<p>Each Severities element can contain one or more Severity elements, each of which corresponds to a severity level: </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
214 |
<ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
215 |
<li><b>Severity</b> element The name of each Severity element matches the name of the corresponding severity level. Each Severity element has the following attribute: |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
216 |
<ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
217 |
<li>enable (boolean) – Specifies whether scripts of a particular severity level are enabled by CodeScanner.</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
218 |
</ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
219 |
</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
220 |
</ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
221 |
<p> Complete list of currently supported Severity elements: </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
222 |
<p class="listing"><severities><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
223 |
<high enable=”true”/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
224 |
|
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
225 |
<medium enable=”true”/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
226 |
<low enable=”false”/><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
227 |
</severities> </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
228 |
<h4><a name="CAT_Element" id="ARG_Element5"></a>Categories Element </h4> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
229 |
<p>Each Categories element can contain one or more Category elements, each of which corresponds to a category of CodeScanner scripts: </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
230 |
<ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
231 |
<li><b>Category</b> element The name of each Category element matches the name of the corresponding script category. Each Category element has the following attribute: |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
232 |
<ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
233 |
<li>enable (boolean) – Specifies whether scripts of a particular category are enabled by CodeScanner. </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
234 |
</ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
235 |
</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
236 |
</ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
237 |
<p>Complete list of currently supported Category elements: </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
238 |
<p class="listing"><categories> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
239 |
<legal enable="true"/><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
240 |
<panic enable=”true”><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
241 |
<canpanic enable="true"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
242 |
<functionality enable=”true”/><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
243 |
<localisation enable="true"/><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
244 |
<performance enable=”true”><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
245 |
<codingstandards enable="true"/><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
246 |
<documentation enable=”false”/><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
247 |
<codereview enable=”false”/><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
248 |
<other enable="true"/> <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
249 |
</categories></p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
250 |
<h4><a name="RULE_Element" id="ARG_Element6"></a>Customrules Element </h4> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
251 |
<p>Each custom rules element can contain one or more custom rule elements, each of which defines a custom rule to be applied by CodeScanner during scanning operation: </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
252 |
<ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
253 |
<li><b>Custom</b> rule element (<span class="code"><customrule></span>, <span class="code"></customrule></span>) </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
254 |
</ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
255 |
<p>Each custom rule element contains the following elements: </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
256 |
<ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
257 |
<li><b>Name</b> element (<span class="code"><name></span>, <span class="code"></name></span>) – The name element specifies the name used by CodeScanner internally to identify a custom rule. A custom rule element can only have one name element.</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
258 |
<li> <b>Keyword</b> element (<span class="code"><keyword></span>, <span class="code"></keyword></span>) – A keyword element specifies a keyword to use when applying a custom rule. A custom rule element can have multiple keyword elements. <br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
259 |
<br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
260 |
A keyword element also has the following attribute: |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
261 |
<ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
262 |
<li>type(string) – specifies the type of a keyword. Here is a list of currently supported keyword types: |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
263 |
<ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
264 |
<li>baseclass (name of the base class from the declaration of a sub-class) </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
265 |
<li>call (name of a called method) </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
266 |
<li>class (name used in the declaration/definition of a class) </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
267 |
<li>comment (keyword from a comment) </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
268 |
<li>generic (keyword used in generic search, i.e. look for anything that matches the keyword) </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
269 |
<li>local (name used in the definition of a local variable)</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
270 |
<li>macro (name used in the definition of a macro) </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
271 |
<li>member (name used in the definition of a data member)</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
272 |
<li> method (name used in the declaration/definition of a method) </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
273 |
<li>parameter (name of a resource statement parameter) </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
274 |
</ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
275 |
</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
276 |
</ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
277 |
</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
278 |
<li><b>File type</b> element (<span class="code"><filetype></span>, <span class="code"></filetype></span>) – A file type element specifies a file extension type to scan when applying a custom rule. A custom rule element can have multiple file type elements. This element is required.</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
279 |
<li><b>Severity</b> element (<span class="code"><severity></span>, <span class="code"></severity></span>) – A severity element specifies the severity level of a custom rule: high, medium or low. A custom rule element can have only one severity element.</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
280 |
<li><b>Title</b> element (<span class="code"><title></span>,<span class="code"> </title></span>) – A title element specifies a title message associated with a custom rule. This is used as the title of HTML report or stdout warning/error message generated when applying a custom rule. A custom rule element can have only one title element.</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
281 |
<li><b>Description</b> element (<span class="code"><description></span>, <span class="code"></description></span>) – A description element specifies a detailed description of a custom rule. This is used when generating HTML reports or warning/error messages for stdout when applying a custom rule. A custom rule element can have zero or one description element.</li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
282 |
<li><b>Link</b> element (<span class="code"><link></span>, <span class="code"></link></span>) – A link element specifies any external link associated with a custom rule. This is used when generating HTML reports or warning/error messages for stdout when applying a custom rule. A custom rule element can have zero or one link element. </li> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
283 |
</ul> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
284 |
<p>An example of CustomRules element: </p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
285 |
<p class="listing"><customrules><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
286 |
<customrule><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
287 |
<name>myOwnRule</name><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
288 |
<keyword type=”class”>CMyOwnClass</keyword><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
289 |
<filetype>h</filetype><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
290 |
<severity>low</severity><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
291 |
<title>My own little CodeScanner rule</title><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
292 |
<description>Locate the definition of CMyOwnClass::MyFunction()</description><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
293 |
<link>http://www.myownsite.nokia.com</link><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
294 |
</customrule><br /> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
295 |
</customrules></p> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
296 |
<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> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
297 |
</body> |
cab50ba61335
added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents:
0
diff
changeset
|
298 |
</html> |
0
fb279309251b
DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff
changeset
|
299 |