added IAD rules to CS manual
authorfturovic <frank.turovich@nokia.com>
Fri, 03 Apr 2009 10:36:32 -0500
changeset 37 c8c1c19ac103
parent 36 131ddbe8aee4
child 38 56290df01690
child 41 ed1bc10577d5
added IAD rules to CS manual
core/com.nokia.carbide.cpp.codescanner/html/release_notes.htm
--- a/core/com.nokia.carbide.cpp.codescanner/html/release_notes.htm	Fri Apr 03 10:36:00 2009 -0500
+++ b/core/com.nokia.carbide.cpp.codescanner/html/release_notes.htm	Fri Apr 03 10:36:32 2009 -0500
@@ -1,85 +1,97 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
-<meta http-equiv="content-type"
- content="text/html; charset=ISO-8859-1">
-<title>Release Notes</title>
-<link href="../book.css" rel="stylesheet" type="text/css">
-</head>
-<body bgcolor="#FFFFFF">
-<h2>CodeScanner Release Notes v2.1.2</h2>
-<ul>
-  <li> <a href="#Changes_from_Previous_Releases">Changes from Previous Releases</a></li>
-  <li><a href="#whatsNew">What's new </a></li>
-  <li><a href="#pi_bugs">Fixed bugs and workarounds</a></li>
-  <li><a href="#support">Technical support</a></li>
-</ul>
-<h3><a name="Changes_from_Previous_Releases"></a>Changes from Previous Releases</h3>
-<ul>
-  <li>Added support for  <a href="pref_codescaner_01.htm">Knowledge Base Scanning</a>, the ability to scan code and detect possible  API issues related to a specific SDK, for example when porting to a new Touch UI SDK. For each SDK, specific porting information is defined as a set of rules specified in  XML files. CodeScanner can merge these into the existing set of CodeScanner rules for   scanning operations. The results are displayed in the <strong>Console</strong> view and as information markers  in source code.</li>
-</ul>
-<h4>2.1.1</h4>
-<ul>
-  <li>Added support for user-defined rules. This can be done by adding a <span class="code">&lt;customrules&gt;</span> element to the configuration file.</li>
-  <li>When scanning with low severity rules, CodeScanner now generates informative messages instead of warnings when the StdOut output format is selected.</li>
-  <li>Added support to disable individual error/warning via CodeScanner command embedded in comments. </li>
-  <li>Added new rule to check whether Cancel() function is called in active object's destructor.<br>
-  </li>
-  <li>Updated active object checking rule to ignore After() from RTimer type member variables.</li>
-  <li>Updated to skip excluded folders specified in configuration file when generating component summary reports.</li>
-</ul>
-<h4>2.1.0</h4>
-<ul>
-  <li>Updated to skip excluded folders specified in configuration file when generating component summary reports.</li>
-  <li>Updated configuration file format to allow passing arguments to CodeScanner. One can now add an &lt;arguments&gt; element to the <br>
-    configuration file.</li>
-  <li>Added new rule to check stack-based resource objects not put on the cleanup stack.</li>
-  <li> Added new rule to check inheritance order of M and C classes. <br>
-  </li>
-  <li>Updated rule for L-functions that cannot leave. It is now possible to specify functions to be ignored by this rule in the<br>
-    configuration file. This is done by adding a &lt;LFunctionIgnoreRE&gt; element to the &lt;LFunctionCantLeave&gt; script element.<br>
-  </li>
-  <li>Updated description of rule for badly-named enum members.</li>
-  <li>Updated NULL equality check rule to ignore pointer comparisons with NULL inside various __ASSERT_XXX() macros.</li>
-  <li>Removed duplicate rule for hard-coded external drive letters. <br>
-  </li>
-  <li>Improved rule for accessing array element by [] without checking range.<br>
-  </li>
-</ul>
-<h4>2.0.9</h4>
-<ul>
-  <li> Updated check for Open() to allow assignment of return value on a different line.</li>
-</ul>
-<h4>2.0.8</h4>
-<ul>
-  <li>Updated check for C class not inheriting from another C class.</li>
-  <li>Updated check for ignored Open() return value.</li>
-  <li>Fixed a bug where some scripts cannot be disabled from the configuration file.</li>
-</ul>
-<h4>2.0.7</h4>
-<ul>
-  <li>  Updated standard console output to include severity level and category information in the error/warning messages.
-  </li>
-  <li>Incorporated Psyco module to improve scanning performance. Please refer to the document &quot;MIT license.txt&quot; for licensing info.</li>
-</ul>
-<h3><a name="whatsNew" id="whatsNew"></a>What's New </h3>
-<ul>
-  
-  <li><a href="optimizing_cs.htm">Added</a> support to disable individual error/warning messages via CodeScanner command in comments.</li>
-  <li>Added support to scan code for porting issues related to new SDKs. </li>
-</ul>
-<h3><a name="pi_bugs"></a>Fixed bugs and workarounds</h3>
-<ul>
-  <li>Complete list of CodeScanner <a href="bugs_fixed.htm">bugs fixed</a></li>
-</ul>
-<p>Workarounds for known issues:</p>
-<ul>
-  <li><i>none to mention </i></li>
-</ul>
-<h3><a name="support" id="support"></a>Technical support </h3>
-<p>The following support services are available:</p>
-<ul><li>Customer feedback - send your comments and suggestions to <a href="mailto:feedback.carbide@nokia.com">feedback.carbide@nokia.com</a></li>
-</ul>
-<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>
-</body>
-</html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="content-type"
+ content="text/html; charset=ISO-8859-1">
+<title>Release Notes</title>
+<link href="../book.css" rel="stylesheet" type="text/css">
+</head>
+<body bgcolor="#FFFFFF">
+<h2>CodeScanner Release Notes v2.1.3</h2>
+<ul>
+  <li> <a href="#Changes_from_Previous_Releases">Changes from Previous Releases</a></li>
+  <li><a href="#whatsNew">What's new </a></li>
+  <li><a href="#pi_bugs">Fixed bugs and workarounds</a></li>
+  <li><a href="#support">Technical support</a></li>
+</ul>
+<h3><a name="Changes_from_Previous_Releases"></a>Changes from Previous Releases</h3>
+<ul>
+  
+  <li>Added support for the following IAD user-defined <a href="customizing_cs.htm">rules</a>. The new rules include:
+    <ul>
+      
+      <li><span class="code">&lt;flags&gt;</span> - new IAD rule to check flag usage</li>
+      <li><span class="code">&lt;crepository&gt; </span>- new IAD rule to check Central Repository usage</li>
+      <li><span class="code">&lt;customizableicons&gt; </span>- new IAD rule to check customizable icons</li>
+    </ul>
+  </li>
+</ul>
+<h4>2.1.2</h4>
+<ul>
+  <li>Added support for  <a href="pref_codescaner_01.htm">Knowledge Base Scanning</a>, the ability to scan code and detect possible  API issues related to a specific SDK, for example when porting to a new Touch UI SDK. For each SDK, specific porting information is defined as a set of rules specified in  XML files. CodeScanner can merge these into the existing set of CodeScanner rules for   scanning operations. The results are displayed in the <strong>Console</strong> view and as information markers  in source code.</li>
+</ul>
+<h4>2.1.1</h4>
+<ul>
+  <li>Added support for user-defined rules. This can be done by adding a <span class="code">&lt;customrules&gt;</span> element to the configuration file.</li>
+  <li>When scanning with low severity rules, CodeScanner now generates informative messages instead of warnings when the StdOut output format is selected.</li>
+  <li>Added support to disable individual error/warning via CodeScanner command embedded in comments. </li>
+  <li>Added new rule to check whether Cancel() function is called in active object's destructor.<br>
+  </li>
+  <li>Updated active object checking rule to ignore After() from RTimer type member variables.</li>
+  <li>Updated to skip excluded folders specified in configuration file when generating component summary reports.</li>
+</ul>
+<h4>2.1.0</h4>
+<ul>
+  <li>Updated to skip excluded folders specified in configuration file when generating component summary reports.</li>
+  <li>Updated configuration file format to allow passing arguments to CodeScanner. One can now add an &lt;arguments&gt; element to the <br>
+    configuration file.</li>
+  <li>Added new rule to check stack-based resource objects not put on the cleanup stack.</li>
+  <li> Added new rule to check inheritance order of M and C classes. <br>
+  </li>
+  <li>Updated rule for L-functions that cannot leave. It is now possible to specify functions to be ignored by this rule in the<br>
+    configuration file. This is done by adding a &lt;LFunctionIgnoreRE&gt; element to the &lt;LFunctionCantLeave&gt; script element.<br>
+  </li>
+  <li>Updated description of rule for badly-named enum members.</li>
+  <li>Updated NULL equality check rule to ignore pointer comparisons with NULL inside various __ASSERT_XXX() macros.</li>
+  <li>Removed duplicate rule for hard-coded external drive letters. <br>
+  </li>
+  <li>Improved rule for accessing array element by [] without checking range.<br>
+  </li>
+</ul>
+<h4>2.0.9</h4>
+<ul>
+  <li> Updated check for Open() to allow assignment of return value on a different line.</li>
+</ul>
+<h4>2.0.8</h4>
+<ul>
+  <li>Updated check for C class not inheriting from another C class.</li>
+  <li>Updated check for ignored Open() return value.</li>
+  <li>Fixed a bug where some scripts cannot be disabled from the configuration file.</li>
+</ul>
+<h4>2.0.7</h4>
+<ul>
+  <li>  Updated standard console output to include severity level and category information in the error/warning messages.
+  </li>
+  <li>Incorporated Psyco module to improve scanning performance. Please refer to the document &quot;MIT license.txt&quot; for licensing info.</li>
+</ul>
+<h3><a name="whatsNew" id="whatsNew"></a>What's New </h3>
+<ul>
+  
+  <li><a href="optimizing_cs.htm">Added</a> support to disable individual error/warning messages via CodeScanner command in comments.</li>
+  <li>Added support to scan code for porting issues related to new SDKs. </li>
+</ul>
+<h3><a name="pi_bugs"></a>Fixed bugs and workarounds</h3>
+<ul>
+  <li>Complete list of CodeScanner <a href="bugs_fixed.htm">bugs fixed</a></li>
+</ul>
+<p>Workarounds for known issues:</p>
+<ul>
+  <li><i>none to mention </i></li>
+</ul>
+<h3><a name="support" id="support"></a>Technical support </h3>
+<p>The following support services are available:</p>
+<ul><li>Customer feedback - send your comments and suggestions to <a href="mailto:feedback.carbide@nokia.com">feedback.carbide@nokia.com</a></li>
+</ul>
+<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>
+</body>
+</html>