Mercurial Repositories > eric / file diff

--- a/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html	Tue Jun 16 20:01:18 2020 +0200
+++ b/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html	Tue Jun 16 20:02:20 2020 +0200
@@ -48,6 +48,10 @@
 <td>Private module function to perform the code style check and/or fix found errors.</td>
 </tr>
 <tr>
+<td><a href="#__checkSyntax">__checkSyntax</a></td>
+<td>Private module function to perform a syntax check.</td>
+</tr>
+<tr>
 <td><a href="#codeStyleBatchCheck">codeStyleBatchCheck</a></td>
 <td>Module function to check code style for a batch of files.</td>
 </tr>
@@ -72,6 +76,10 @@
 <td>Initialize the service and return the entry point.</td>
 </tr>
 <tr>
+<td><a href="#securityOk">securityOk</a></td>
+<td>Function to check, if the given code is an acknowledged security report.</td>
+</tr>
+<tr>
 <td><a href="#worker">worker</a></td>
 <td>Module function acting as the parallel worker for the style check.</td>
 </tr>
@@ -192,8 +200,8 @@
         excludeMessages, includeMessages, repeatMessages, fixCodes,
         noFixCodes, fixIssues, maxLineLength, maxDocLineLength, blankLines,
         hangClosing, docType, codeComplexityArgs, miscellaneousArgs,
-        annotationArgs, errors, eol, encoding, backup)
-        bool, str, dict, dict, list of str, str, str, bool)
+        annotationArgs, securityArgs, errors, eol, encoding, backup)
+        bool, str, dict, dict, dict, list of str, str, str, bool)
 </dd>
 </dl>
 <dl>
@@ -224,6 +232,40 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
+<a NAME="__checkSyntax" ID="__checkSyntax"></a>
+<h2>__checkSyntax</h2>
+<b>__checkSyntax</b>(<i>filename, source</i>)
+
+<p>
+    Private module function to perform a syntax check.
+</p>
+<dl>
+
+<dt><i>filename</i> (str)</dt>
+<dd>
+source filename
+</dd>
+<dt><i>source</i> (str)</dt>
+<dd>
+string containing the code to check
+</dd>
+</dl>
+<dl>
+<dt>Returns:</dt>
+<dd>
+tuple containing the error dictionary with syntax error details
+        and a statistics dictionary or a tuple containing two None
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (dict, dict) or tuple of (None, None)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
 <a NAME="codeStyleBatchCheck" ID="codeStyleBatchCheck"></a>
 <h2>codeStyleBatchCheck</h2>
 <b>codeStyleBatchCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>)
@@ -403,6 +445,39 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <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>
+
+<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>Returns:</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 />
 <a NAME="worker" ID="worker"></a>
 <h2>worker</h2>
 <b>worker</b>(<i>inputQueue, outputQueue</i>)