--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html Thu May 25 19:51:47 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html Thu May 25 19:52:31 2023 +0200
@@ -31,7 +31,7 @@
<tr>
<td><a href="#__checkCodeStyle">__checkCodeStyle</a></td>
-<td>Private module function to perform the code style check and/or fix found errors.</td>
+<td>Private module function to perform the source code style check and/or fix found errors.</td>
</tr>
<tr>
<td><a href="#__checkSyntax">__checkSyntax</a></td>
@@ -39,11 +39,11 @@
</tr>
<tr>
<td><a href="#codeStyleBatchCheck">codeStyleBatchCheck</a></td>
-<td>Module function to check code style for a batch of files.</td>
+<td>Module function to check source code style for a batch of files.</td>
</tr>
<tr>
<td><a href="#codeStyleCheck">codeStyleCheck</a></td>
-<td>Do the code style check and/or fix found errors.</td>
+<td>Do the source code style check and/or fix found errors.</td>
</tr>
<tr>
<td><a href="#extractLineFlags">extractLineFlags</a></td>
@@ -63,7 +63,7 @@
</tr>
<tr>
<td><a href="#securityOk">securityOk</a></td>
-<td>Function to check, if the given code is an acknowledged security report.</td>
+<td></td>
</tr>
<tr>
<td><a href="#workerTask">workerTask</a></td>
@@ -125,7 +125,7 @@
</dl>
<a NAME="CodeStyleCheckerReport.error_args" ID="CodeStyleCheckerReport.error_args"></a>
<h4>CodeStyleCheckerReport.error_args</h4>
-<b>error_args</b>(<i>line_number, offset, code, check, *args</i>)
+<b>error_args</b>(<i>line_number, offset, errorCode, check, *args</i>)
<p>
Public method to collect the error messages.
@@ -140,9 +140,9 @@
<dd>
position within line of the issue (integer)
</dd>
-<dt><i>code</i></dt>
+<dt><i>errorCode</i></dt>
<dd>
-message code (string)
+error message code (string)
</dd>
<dt><i>check</i></dt>
<dd>
@@ -167,7 +167,7 @@
<b>__checkCodeStyle</b>(<i>filename, source, args</i>)
<p>
- Private module function to perform the code style check and/or fix
+ Private module function to perform the source code style check and/or fix
found errors.
</p>
<dl>
@@ -178,7 +178,7 @@
</dd>
<dt><i>source</i> (str)</dt>
<dd>
-string containing the code to check
+string containing the source code to check
</dd>
<dt><i>args</i> (list of (str, str, bool, str, str, bool, int, list of (int, int),)</dt>
<dd>
@@ -200,7 +200,7 @@
<li>file: file name</li>
<li>line: line_number</li>
<li>offset: offset within line</li>
- <li>code: message code</li>
+ <li>code: error message code</li>
<li>args: list of arguments to format the message</li>
<li>ignored: flag indicating this issue was ignored</li>
<li>fixed: flag indicating this issue was fixed</li>
@@ -234,7 +234,7 @@
</dd>
<dt><i>source</i> (str)</dt>
<dd>
-string containing the code to check
+string containing the source code to check
</dd>
</dl>
<dl>
@@ -259,7 +259,7 @@
<b>codeStyleBatchCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>)
<p>
- Module function to check code style for a batch of files.
+ Module function to check source code style for a batch of files.
</p>
<dl>
@@ -292,7 +292,7 @@
<b>codeStyleCheck</b>(<i>filename, source, args</i>)
<p>
- Do the code style check and/or fix found errors.
+ Do the source code style check and/or fix found errors.
</p>
<dl>
@@ -302,7 +302,7 @@
</dd>
<dt><i>source</i> (str)</dt>
<dd>
-string containing the code to check
+string containing the source code to check
</dd>
<dt><i>args</i> (list of (str, str, bool, str, str, bool, int, list of (int, int),)</dt>
<dd>
@@ -371,14 +371,14 @@
<hr />
<a NAME="ignoreCode" ID="ignoreCode"></a>
<h2>ignoreCode</h2>
-<b>ignoreCode</b>(<i>code, lineFlags</i>)
+<b>ignoreCode</b>(<i>errorCode, lineFlags</i>)
<p>
Function to check, if the given code should be ignored as per line flags.
</p>
<dl>
-<dt><i>code</i> (str)</dt>
+<dt><i>errorCode</i> (str)</dt>
<dd>
error code to be checked
</dd>
@@ -390,7 +390,7 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating to ignore the code
+flag indicating to ignore the error code
</dd>
</dl>
<dl>
@@ -436,34 +436,8 @@
<hr />
<a NAME="securityOk" ID="securityOk"></a>
<h2>securityOk</h2>
-<b>securityOk</b>(<i>code, lineFlags</i>)
-
-<p>
- Function to check, if the given code is an acknowledged security report.
-</p>
-<dl>
+<b>securityOk</b>(<i>errorCode, lineFlags</i>)
-<dt><i>code</i> (str)</dt>
-<dd>
-error code to be checked
-</dd>
-<dt><i>lineFlags</i> (list of str)</dt>
-<dd>
-list of line flags to check against
-</dd>
-</dl>
-<dl>
-<dt>Return:</dt>
-<dd>
-flag indicating an acknowledged security report
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-bool
-</dd>
-</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
