core/com.nokia.carbide.cpp.codescanner/html/customizing_cs.htm
author Dan Podwall <dan.podwall@nokia.com>
Mon, 27 Apr 2009 15:07:35 -0500
changeset 128 c028612cc555
parent 36 131ddbe8aee4
parent 69 cab50ba61335
permissions -rw-r--r--
merge from RCL_2_0 to MCL
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 &ndash; 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 &ndash; 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 &ndash; 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 &ndash; 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 &ndash; 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 &ndash; 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">&lt;input&gt;</span>, <span class="code">&lt;/input&gt;</span>) &ndash; 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">&lt;outputformat&gt;</span>, <span class="code">&lt;/outputformat&gt;</span>) &ndash; 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 &ndash; generate HTML report</li>
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    33
         <li> xml &ndash; generate an XML report</li>
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    34
         <li> std &ndash; 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">&lt;lxr&gt;</span>, <span class="code">&lt;/lxr&gt;</span>) &ndash;  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">&lt;lxrversion&gt;</span>, <span class="code">&lt;/lxrversion&gt;</span>) &ndash; 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">&lt;timestampedoutput&gt;</span>, <span class="code">&lt;/timestampedoutput&gt;</span>) &ndash; 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">&lt;arguments&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    43
   &nbsp;&nbsp;&nbsp;&nbsp;&lt;input&gt;C:\Symbian\9.2\Epoc32\include&lt;/input&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    44
    &nbsp;&nbsp;&nbsp;&nbsp;&lt;input&gt;C:\CodeScanner_Tests\includes&lt;/input&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    45
   &nbsp;&nbsp;&nbsp;&nbsp;&lt;lxr&gt;http://s60lxr/source/&lt;/lxr&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    46
     &nbsp;&nbsp;&nbsp;
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    47
   &lt;lxrversion&gt;S60_3_2_200736&lt;/lxrversion&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    48
   &nbsp;&nbsp;&nbsp;&nbsp;&lt;outputformat&gt;html|std&lt;/outputformat&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    49
   &nbsp;&nbsp;&nbsp;&nbsp;&lt;timestampedoutput&gt;on&lt;/timestampedoutput&gt; <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    50
   &lt;/arguments&gt; </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">&lt;excludes&gt;</span>, <span class="code">&lt;/excludes&gt;</span>) &ndash; 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">&lt;sources&gt;     <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    58
     &nbsp;&nbsp;&nbsp;&nbsp;&lt;exclude&gt;.*\.avi&lt;/exclude&gt;     <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    59
     &nbsp;&nbsp;&nbsp;&nbsp;&lt;exclude&gt;.*\.bmp&lt;/exclude&gt;     <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    60
     &nbsp;&nbsp;&nbsp;&nbsp;&lt;exclude&gt;.*\.jpg&lt;/exclude&gt;     <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    61
     &nbsp;&nbsp;&nbsp;&nbsp;&lt;exclude&gt;.*\\test\\.*&lt;/exclude&gt; <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    62
   &lt;/sources&gt; </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) &ndash; 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) &ndash; 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) &ndash; 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">&lt;wordsRE&gt;</span>, <span class="code">&lt;/wordsRE&gt;</span>) &ndash; 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 &ndash; 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">&lt;LFunctionIgnoreRE&gt;</span>, <span class="code">&lt;/LFunctionIgnoreRE&gt;</span>) &ndash; 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">&lt;cclassIgnoreRE&gt;</span>, <span class="code">&lt;/cclassIgnoreRE&gt;</span>) &ndash; 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">&lt;openIgnoreRE&gt;</span>, <span class="code">&lt;/openIgnoreRE&gt;</span>) &ndash; 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">&lt;worryRE&gt;</span>, <span class="code">&lt;/ worryRE&gt;</span>) &ndash; 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">&lt;scripts&gt;<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
&lt;accessArrayElementWithoutCheck category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    86
&lt;accessArrayElementWithoutCheck2 category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    87
&lt;activestart category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    88
&lt;activestop category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    89
&lt;arraypassing category=&quot;performance&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    90
&lt;arrayptrcleanup category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    91
&lt;assertdebuginvariant category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;<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
&lt;baddefines category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    94
&lt;baseconstruct category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;<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
&lt;callActiveObjectWithoutCheckingOrStopping category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   &lt;changenotification category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    97
&lt;cleanup category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    98
&lt;commentcode category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    99
&lt;connect category=&quot;canpanic&quot; enable=&quot;true&quot; severity=&quot;high&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   100
&lt;ConnectAndDontCloseMemberVariable category=&quot;functionality&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   &lt;constnames category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   101
&lt;consttdescptr category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
36
131ddbe8aee4 added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   102
&lt;controlornull category=&quot;canpanic&quot; enable=&quot;true&quot; severity=&quot;high&quot;/&gt;   <br>
69
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   103
&lt;crepository category=&quot;other&quot;                   enable=&quot;true&quot;                   severity=&quot;low&quot;/&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   104
&lt;ctltargettype category=&quot;functionality&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   105
&lt;customizableicons category=&quot;other&quot;                         enable=&quot;true&quot;                         severity=&quot;low&quot;&gt;<br>
36
131ddbe8aee4 added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   106
	&nbsp;&nbsp;&nbsp;&nbsp;&lt;iconsRE&gt;iconA.bmp|iconB.svg|iconC&lt;/iconsRE&gt;     <br>
131ddbe8aee4 added IAD rules to CS manual
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   107
	&lt;/customizableicons&gt;<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
&lt;debugrom category=&quot;performance&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   110
&lt;declarename category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   111
&lt;deleteMemberVariable category=&quot;canpanic&quot; enable=&quot;true&quot; severity=&quot;high&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   112
&lt;destructor category=&quot;canpanic&quot; enable=&quot;true&quot; severity=&quot;high&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   113
&lt;doubleSemiColon category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   114
&lt;driveletters category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <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
&lt;eikbuttons category=&quot;localisation&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   117
&lt;eikonenvstatic category=&quot;performance&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   118
&lt;enummembers category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   119
&lt;enumnames category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   120
&lt;exportinline category=&quot;functionality&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   121
&lt;exportpurevirtual category=&quot;functionality&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   <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
&lt;flags category=&quot;other&quot;             enable=&quot;true&quot;             severity=&quot;low&quot;/&gt;<br>
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   124
&lt;foff category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   125
&lt;forbiddenwords category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;&gt;       <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   126
&nbsp;&nbsp;&nbsp;&nbsp;&lt;wordsRE&gt;Epoc|Nokia Mobile Phones|NMP|(^|\s)S60&lt;/wordsRE&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   127
&lt;/forbiddenwords&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   128
&lt;forgottoputptroncleanupstack category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   129
&lt;friend category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <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
&lt;goto category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <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
&lt;ifassignments category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   134
&lt;ifpreprocessor category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   135
&lt;inheritanceorder category=&quot;canpanic&quot; enable=&quot;true&quot; severity=&quot;high&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   136
&lt;intleaves category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <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
&lt;jmp category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <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
&lt;leave category=&quot;canpanic&quot; enable=&quot;true&quot; severity=&quot;high&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   141
&lt;LeaveNoError category=&quot;functionality&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   142
&lt;leavingoperators category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   143
&lt;LFunctionCantLeave category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;&gt;       &lt;LFunctionIgnoreRE&gt;RunL&lt;/LFunctionIgnoreRE&gt;   &lt;/LFunctionCantLeave&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   144
&lt;longlines category=&quot;codingstandards&quot; enable=&quot;true&quot; length=&quot;160&quot; severity=&quot;low&quot;/&gt;   <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
&lt;magicnumbers category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   147
&lt;mclassdestructor category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   148
&lt;memberlc category=&quot;canpanic&quot; enable=&quot;true&quot; severity=&quot;high&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   149
&lt;membervariablecallld category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   150
&lt;missingcancel category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   151
&lt;missingcclass category=&quot;canpanic&quot; enable=&quot;true&quot; severity=&quot;high&quot;&gt;       &nbsp;&nbsp;&nbsp;&nbsp;&lt;cclassIgnoreRE&gt;CBase&lt;/cclassIgnoreRE&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   152
&lt;/missingcclass&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   153
&lt;mmpsourcepath category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   154
&lt;multilangrsc category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   155
&lt;multipledeclarations category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   156
&lt;multipleinheritance category=&quot;functionality&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   157
&lt;mydocs category=&quot;functionality&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   <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
&lt;namespace category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   160
&lt;newlreferences category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   161
&lt;noleavetrap category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   162
&lt;nonconsthbufc category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   163
&lt;nonconsttdesc category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   164
&lt;nonleavenew category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   165
&lt;nonunicodeskins category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   166
&lt;null category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <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
&lt;open category=&quot;canpanic&quot; enable=&quot;true&quot; severity=&quot;high&quot;&gt;       &nbsp;&nbsp;&nbsp;&nbsp;&lt;openIgnoreRE&gt;RDesReadStream|RDesWriteStream&lt;/openIgnoreRE&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   169
&lt;/open&gt;   <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
&lt;pointertoarrays category=&quot;performance&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   172
&lt;pragmadisable category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   173
&lt;pragmamessage category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   174
&lt;pragmaother category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   175
&lt;privateinheritance category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   176
&lt;pushaddrvar category=&quot;canpanic&quot; enable=&quot;true&quot; severity=&quot;high&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   177
&lt;pushmember category=&quot;canpanic&quot; enable=&quot;true&quot; severity=&quot;high&quot;/&gt;   <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
&lt;readresource category=&quot;canpanic&quot; enable=&quot;true&quot; severity=&quot;high&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   180
&lt;resourcenotoncleanupstack category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   181
&lt;resourcesonheap category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   &lt;returndescriptoroutofscope category=&quot;canpanic&quot; enable=&quot;true&quot; severity=&quot;high&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   182
&lt;rfs category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   183
&lt;rssnames category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <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
&lt;stringliterals category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   186
&lt;stringsinresourcefiles category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   187
&lt;struct category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <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
&lt;tcclasses category=&quot;functionality&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   190
&lt;tclassdestructor category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   191
&lt;todocomments category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   192
&lt;trapcleanup category=&quot;panic&quot; enable=&quot;true&quot; severity=&quot;high&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   193
&lt;trapeleave category=&quot;performance&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   194
&lt;traprunl category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   195
&lt;trspassing category=&quot;functionality&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   <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
&lt;uids category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   198
&lt;uncompressedaif category=&quot;performance&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   199
&lt;uncompressedbmp category=&quot;performance&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   200
&lt;unicodesource category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   201
&lt;userafter category=&quot;performance&quot; enable=&quot;true&quot; severity=&quot;medium&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   202
&lt;userfree category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   203
&lt;userWaitForRequest category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <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
&lt;variablenames category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   206
&lt;voidparameter category=&quot;codingstandards&quot; enable=&quot;true&quot; severity=&quot;low&quot;/&gt;   <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
&lt;worryingcomments category=&quot;codereview&quot; enable=&quot;true&quot; severity=&quot;low&quot;&gt;       &nbsp;&nbsp;&nbsp;&nbsp;&lt;worryRE&gt;\!|\?|[Zz]{3}|kludge|workaround|\scrap|hack&lt;/worryRE&gt;   <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   209
&lt;/worryingcomments&gt;<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">&lt;/scripts&gt; </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) &ndash; 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">&lt;severities&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   223
    &nbsp;&nbsp;&nbsp;&nbsp;&lt;high enable=&rdquo;true&rdquo;/&gt;     <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   224
      &nbsp;&nbsp;&nbsp;
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   225
   &lt;medium enable=&rdquo;true&rdquo;/&gt;     <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   226
    &nbsp;&nbsp;&nbsp;&nbsp;&lt;low enable=&rdquo;false&rdquo;/&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   227
   &lt;/severities&gt; </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) &ndash; 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">&lt;categories&gt;     <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   239
   &nbsp;&nbsp;&nbsp;&nbsp;&lt;legal enable=&quot;true&quot;/&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   240
   &nbsp;&nbsp;&nbsp;&nbsp;&lt;panic enable=&rdquo;true&rdquo;&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   241
   &nbsp;&nbsp;&nbsp;&nbsp;&lt;canpanic enable=&quot;true&quot;/&gt;     <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   242
   &nbsp;&nbsp;&nbsp;&nbsp;&lt;functionality enable=&rdquo;true&rdquo;/&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   243
   &nbsp;&nbsp;&nbsp;&nbsp;&lt;localisation enable=&quot;true&quot;/&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   244
   &nbsp;&nbsp;&nbsp;&nbsp;&lt;performance enable=&rdquo;true&rdquo;&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   245
   &nbsp;&nbsp;&nbsp;&nbsp;&lt;codingstandards enable=&quot;true&quot;/&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   246
   &nbsp;&nbsp;&nbsp;&nbsp;&lt;documentation enable=&rdquo;false&rdquo;/&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   247
   &nbsp;&nbsp;&nbsp;&nbsp;&lt;codereview enable=&rdquo;false&rdquo;/&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   248
   &nbsp;&nbsp;&nbsp;&nbsp;&lt;other enable=&quot;true&quot;/&gt; <br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   249
   &lt;/categories&gt;</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">&lt;customrule&gt;</span>, <span class="code">&lt;/customrule&gt;</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">&lt;name&gt;</span>, <span class="code">&lt;/name&gt;</span>) &ndash; 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">&lt;keyword&gt;</span>, <span class="code">&lt;/keyword&gt;</span>) &ndash; 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) &ndash; 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">&lt;filetype&gt;</span>, <span class="code">&lt;/filetype&gt;</span>) &ndash; 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">&lt;severity&gt;</span>, <span class="code">&lt;/severity&gt;</span>) &ndash; 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">&lt;title&gt;</span>,<span class="code"> &lt;/title&gt;</span>) &ndash; 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">&lt;description&gt;</span>, <span class="code">&lt;/description&gt;</span>) &ndash; 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">&lt;link&gt;</span>, <span class="code">&lt;/link&gt;</span>) &ndash; 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">&lt;customrules&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   286
   &nbsp;&nbsp;&nbsp;&nbsp;&lt;customrule&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   287
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;name&gt;myOwnRule&lt;/name&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   288
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;keyword type=&rdquo;class&rdquo;&gt;CMyOwnClass&lt;/keyword&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   289
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;filetype&gt;h&lt;/filetype&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   290
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;severity&gt;low&lt;/severity&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   291
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;title&gt;My own little CodeScanner rule&lt;/title&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   292
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;description&gt;Locate the definition of CMyOwnClass::MyFunction()&lt;/description&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   293
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;link&gt;http://www.myownsite.nokia.com&lt;/link&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   294
   &nbsp;&nbsp;&nbsp;&nbsp;&lt;/customrule&gt;<br />
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   295
   &lt;/customrules&gt;</p>
cab50ba61335 added info on IAD custom rules
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   296
   <div id="footer">Copyright &copy; 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