--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,28 +7,25 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker</h1>
-
<p>
Module implementing the code style checker.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#CodeStyleCheckerReport">CodeStyleCheckerReport</a></td>
<td>Class implementing a special report to be used with our dialog.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#__checkCodeStyle">__checkCodeStyle</a></td>
<td>Private module function to perform the source code style check and/or fix found errors.</td>
@@ -70,30 +67,29 @@
<td>Module function acting as the parallel worker for the style check.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="CodeStyleCheckerReport" ID="CodeStyleCheckerReport"></a>
<h2>CodeStyleCheckerReport</h2>
-
<p>
Class implementing a special report to be used with our dialog.
</p>
+
<h3>Derived from</h3>
pycodestyle.BaseReport
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#CodeStyleCheckerReport.__init__">CodeStyleCheckerReport</a></td>
<td>Constructor</td>
@@ -103,19 +99,20 @@
<td>Public method to collect the error messages.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="CodeStyleCheckerReport.__init__" ID="CodeStyleCheckerReport.__init__"></a>
<h4>CodeStyleCheckerReport (Constructor)</h4>
<b>CodeStyleCheckerReport</b>(<i>options</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>options</i> (optparse.Values)</dt>
@@ -126,10 +123,10 @@
<a NAME="CodeStyleCheckerReport.error_args" ID="CodeStyleCheckerReport.error_args"></a>
<h4>CodeStyleCheckerReport.error_args</h4>
<b>error_args</b>(<i>line_number, offset, errorCode, check, *args</i>)
-
<p>
Public method to collect the error messages.
</p>
+
<dl>
<dt><i>line_number</i> (int)</dt>
@@ -171,11 +168,11 @@
<a NAME="__checkCodeStyle" ID="__checkCodeStyle"></a>
<h2>__checkCodeStyle</h2>
<b>__checkCodeStyle</b>(<i>filename, source, args</i>)
-
<p>
Private module function to perform the source code style check and/or fix
found errors.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -228,10 +225,10 @@
<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>
@@ -263,10 +260,10 @@
<a NAME="codeStyleBatchCheck" ID="codeStyleBatchCheck"></a>
<h2>codeStyleBatchCheck</h2>
<b>codeStyleBatchCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>)
-
<p>
Module function to check source code style for a batch of files.
</p>
+
<dl>
<dt><i>argumentsList</i> (list)</dt>
@@ -296,10 +293,10 @@
<a NAME="codeStyleCheck" ID="codeStyleCheck"></a>
<h2>codeStyleCheck</h2>
<b>codeStyleCheck</b>(<i>filename, source, args</i>)
-
<p>
Do the source code style check and/or fix found errors.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -342,11 +339,11 @@
<a NAME="extractLineFlags" ID="extractLineFlags"></a>
<h2>extractLineFlags</h2>
<b>extractLineFlags</b>(<i>line, startComment="</i>)
-
<p>
Function to extract flags starting and ending with '__' from a line
comment.
</p>
+
<dl>
<dt><i>line</i> (str)</dt>
@@ -384,10 +381,10 @@
<a NAME="ignoreCode" ID="ignoreCode"></a>
<h2>ignoreCode</h2>
<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>errorCode</i> (str)</dt>
@@ -417,10 +414,10 @@
<a NAME="initBatchService" ID="initBatchService"></a>
<h2>initBatchService</h2>
<b>initBatchService</b>(<i></i>)
-
<p>
Initialize the batch service and return the entry point.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -439,10 +436,10 @@
<a NAME="initService" ID="initService"></a>
<h2>initService</h2>
<b>initService</b>(<i></i>)
-
<p>
Initialize the service and return the entry point.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -461,10 +458,10 @@
<a NAME="securityOk" ID="securityOk"></a>
<h2>securityOk</h2>
<b>securityOk</b>(<i>errorCode, lineFlags</i>)
-
<p>
Function to check, if the given error code is an acknowledged security report.
</p>
+
<dl>
<dt><i>errorCode</i> (str)</dt>
@@ -494,10 +491,10 @@
<a NAME="workerTask" ID="workerTask"></a>
<h2>workerTask</h2>
<b>workerTask</b>(<i>inputQueue, outputQueue</i>)
-
<p>
Module function acting as the parallel worker for the style check.
</p>
+
<dl>
<dt><i>inputQueue</i> (multiprocessing.Queue)</dt>
@@ -511,4 +508,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
