src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityChecker.html

branch
eric7
changeset 11150
73d80859079c
parent 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityChecker.html	Thu Feb 27 09:22:15 2025 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityChecker.html	Thu Feb 27 14:42:39 2025 +0100
@@ -38,9 +38,10 @@
 </p>
 
 <h3>Derived from</h3>
-None
+CodeStyleTopicChecker
 <h3>Class Attributes</h3>
 <table>
+<tr><td>Category</td></tr>
 <tr><td>Codes</td></tr>
 </table>
 
@@ -56,18 +57,14 @@
 <td>Constructor</td>
 </tr>
 <tr>
-<td><a href="#SecurityChecker.__ignoreCode">__ignoreCode</a></td>
-<td>Private method to check if the message code should be ignored.</td>
+<td><a href="#SecurityChecker.addError">addError</a></td>
+<td>Public method to record an issue.</td>
 </tr>
 <tr>
 <td><a href="#SecurityChecker.getConfig">getConfig</a></td>
 <td>Public method to get the configuration dictionary.</td>
 </tr>
 <tr>
-<td><a href="#SecurityChecker.reportError">reportError</a></td>
-<td>Public method to record an issue.</td>
-</tr>
-<tr>
 <td><a href="#SecurityChecker.run">run</a></td>
 <td>Public method to check the given source against security related conditions.</td>
 </tr>
@@ -121,30 +118,40 @@
 dictionary of arguments for the security checks
 </dd>
 </dl>
-<a NAME="SecurityChecker.__ignoreCode" ID="SecurityChecker.__ignoreCode"></a>
-<h4>SecurityChecker.__ignoreCode</h4>
-<b>__ignoreCode</b>(<i>code</i>)
+<a NAME="SecurityChecker.addError" ID="SecurityChecker.addError"></a>
+<h4>SecurityChecker.addError</h4>
+<b>addError</b>(<i>lineNumber, offset, msgCode, severity, confidence, *args</i>)
 <p>
-        Private method to check if the message code should be ignored.
+        Public method to record an issue.
 </p>
 
 <dl>
 
-<dt><i>code</i> (str)</dt>
+<dt><i>lineNumber</i> (int)</dt>
 <dd>
-message code to check for
+line number of the issue
 </dd>
-</dl>
-<dl>
-<dt>Return:</dt>
+<dt><i>offset</i> (int)</dt>
+<dd>
+position within line of the issue
+</dd>
+<dt><i>msgCode</i> (str)</dt>
 <dd>
-flag indicating to ignore the given code
+message code
+</dd>
+<dt><i>severity</i> (str)</dt>
+<dd>
+severity code (H = high, M = medium, L = low,
+            U = undefined)
 </dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
+<dt><i>confidence</i> (str)</dt>
 <dd>
-bool
+confidence code (H = high, M = medium, L = low,
+            U = undefined)
+</dd>
+<dt><i>args</i> (list)</dt>
+<dd>
+arguments for the message
 </dd>
 </dl>
 <a NAME="SecurityChecker.getConfig" ID="SecurityChecker.getConfig"></a>
@@ -166,42 +173,6 @@
 dict
 </dd>
 </dl>
-<a NAME="SecurityChecker.reportError" ID="SecurityChecker.reportError"></a>
-<h4>SecurityChecker.reportError</h4>
-<b>reportError</b>(<i>lineNumber, offset, code, severity, confidence, *args</i>)
-<p>
-        Public method to record an issue.
-</p>
-
-<dl>
-
-<dt><i>lineNumber</i> (int)</dt>
-<dd>
-line number of the issue
-</dd>
-<dt><i>offset</i> (int)</dt>
-<dd>
-position within line of the issue
-</dd>
-<dt><i>code</i> (str)</dt>
-<dd>
-message code
-</dd>
-<dt><i>severity</i> (str)</dt>
-<dd>
-severity code (H = high, M = medium, L = low,
-            U = undefined)
-</dd>
-<dt><i>confidence</i> (str)</dt>
-<dd>
-confidence code (H = high, M = medium, L = low,
-            U = undefined)
-</dd>
-<dt><i>args</i> (list)</dt>
-<dd>
-arguments for the message
-</dd>
-</dl>
 <a NAME="SecurityChecker.run" ID="SecurityChecker.run"></a>
 <h4>SecurityChecker.run</h4>
 <b>run</b>(<i></i>)

eric ide

mercurial