--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginCodeStyleChecker.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginCodeStyleChecker.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,37 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.PluginCodeStyleChecker</h1>
-
<p>
Module implementing the code style checker plug-in.
</p>
+
<h3>Global Attributes</h3>
-
<table>
-<tr><td>__header__</td></tr><tr><td>error</td></tr>
+<tr><td>__header__</td></tr>
+<tr><td>error</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#CodeStyleCheckerPlugin">CodeStyleCheckerPlugin</a></td>
<td>Class implementing the code style checker plug-in.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="CodeStyleCheckerPlugin" ID="CodeStyleCheckerPlugin"></a>
<h2>CodeStyleCheckerPlugin</h2>
-
<p>
Class implementing the code style checker plug-in.
</p>
+
<h3>Signals</h3>
<dl>
@@ -58,19 +58,17 @@
<h3>Derived from</h3>
QObject
<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="#CodeStyleCheckerPlugin.__init__">CodeStyleCheckerPlugin</a></td>
<td>Constructor</td>
@@ -148,19 +146,20 @@
<td>Public method to prepare a style check on one Python source file.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="CodeStyleCheckerPlugin.__init__" ID="CodeStyleCheckerPlugin.__init__"></a>
<h4>CodeStyleCheckerPlugin (Constructor)</h4>
<b>CodeStyleCheckerPlugin</b>(<i>ui</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>ui</i> (UserInterface)</dt>
@@ -171,10 +170,10 @@
<a NAME="CodeStyleCheckerPlugin.__editorClosed" ID="CodeStyleCheckerPlugin.__editorClosed"></a>
<h4>CodeStyleCheckerPlugin.__editorClosed</h4>
<b>__editorClosed</b>(<i>editor</i>)
-
<p>
Private slot called, when an editor was closed.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -185,18 +184,18 @@
<a NAME="CodeStyleCheckerPlugin.__editorCodeStyleCheck" ID="CodeStyleCheckerPlugin.__editorCodeStyleCheck"></a>
<h4>CodeStyleCheckerPlugin.__editorCodeStyleCheck</h4>
<b>__editorCodeStyleCheck</b>(<i></i>)
-
<p>
Private slot to handle the code style check context menu action
of the editors.
</p>
+
<a NAME="CodeStyleCheckerPlugin.__editorOpened" ID="CodeStyleCheckerPlugin.__editorOpened"></a>
<h4>CodeStyleCheckerPlugin.__editorOpened</h4>
<b>__editorOpened</b>(<i>editor</i>)
-
<p>
Private slot called, when a new editor was opened.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -207,11 +206,11 @@
<a NAME="CodeStyleCheckerPlugin.__editorShowMenu" ID="CodeStyleCheckerPlugin.__editorShowMenu"></a>
<h4>CodeStyleCheckerPlugin.__editorShowMenu</h4>
<b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
-
<p>
Private slot called, when the the editor context menu or a submenu is
about to be shown.
</p>
+
<dl>
<dt><i>menuName</i> (str)</dt>
@@ -230,26 +229,26 @@
<a NAME="CodeStyleCheckerPlugin.__initialize" ID="CodeStyleCheckerPlugin.__initialize"></a>
<h4>CodeStyleCheckerPlugin.__initialize</h4>
<b>__initialize</b>(<i></i>)
-
<p>
Private slot to (re)initialize the plugin.
</p>
+
<a NAME="CodeStyleCheckerPlugin.__projectBrowserCodeStyleCheck" ID="CodeStyleCheckerPlugin.__projectBrowserCodeStyleCheck"></a>
<h4>CodeStyleCheckerPlugin.__projectBrowserCodeStyleCheck</h4>
<b>__projectBrowserCodeStyleCheck</b>(<i></i>)
-
<p>
Private method to handle the code style check context menu action of
the project sources browser.
</p>
+
<a NAME="CodeStyleCheckerPlugin.__projectBrowserShowMenu" ID="CodeStyleCheckerPlugin.__projectBrowserShowMenu"></a>
<h4>CodeStyleCheckerPlugin.__projectBrowserShowMenu</h4>
<b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>)
-
<p>
Private slot called, when the the project browser menu or a submenu is
about to be shown.
</p>
+
<dl>
<dt><i>menuName</i> (str)</dt>
@@ -264,18 +263,18 @@
<a NAME="CodeStyleCheckerPlugin.__projectCodeStyleCheck" ID="CodeStyleCheckerPlugin.__projectCodeStyleCheck"></a>
<h4>CodeStyleCheckerPlugin.__projectCodeStyleCheck</h4>
<b>__projectCodeStyleCheck</b>(<i></i>)
-
<p>
Private slot used to check the project files for code style.
</p>
+
<a NAME="CodeStyleCheckerPlugin.__projectShowMenu" ID="CodeStyleCheckerPlugin.__projectShowMenu"></a>
<h4>CodeStyleCheckerPlugin.__projectShowMenu</h4>
<b>__projectShowMenu</b>(<i>menuName, menu</i>)
-
<p>
Private slot called, when the the project menu or a submenu is
about to be shown.
</p>
+
<dl>
<dt><i>menuName</i> (str)</dt>
@@ -290,10 +289,10 @@
<a NAME="CodeStyleCheckerPlugin.__serviceError" ID="CodeStyleCheckerPlugin.__serviceError"></a>
<h4>CodeStyleCheckerPlugin.__serviceError</h4>
<b>__serviceError</b>(<i>fn, msg</i>)
-
<p>
Private slot handling service errors.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -308,10 +307,10 @@
<a NAME="CodeStyleCheckerPlugin.__translateStyleCheck" ID="CodeStyleCheckerPlugin.__translateStyleCheck"></a>
<h4>CodeStyleCheckerPlugin.__translateStyleCheck</h4>
<b>__translateStyleCheck</b>(<i>fn, codeStyleCheckerStats, results</i>)
-
<p>
Private slot called after performing a style check on one file.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -331,10 +330,10 @@
<a NAME="CodeStyleCheckerPlugin.activate" ID="CodeStyleCheckerPlugin.activate"></a>
<h4>CodeStyleCheckerPlugin.activate</h4>
<b>activate</b>(<i></i>)
-
<p>
Public method to activate this plugin.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -350,10 +349,10 @@
<a NAME="CodeStyleCheckerPlugin.batchJobDone" ID="CodeStyleCheckerPlugin.batchJobDone"></a>
<h4>CodeStyleCheckerPlugin.batchJobDone</h4>
<b>batchJobDone</b>(<i>fx, lang</i>)
-
<p>
Public slot handling the completion of a batch job.
</p>
+
<dl>
<dt><i>fx</i> (str)</dt>
@@ -368,24 +367,24 @@
<a NAME="CodeStyleCheckerPlugin.cancelStyleBatchCheck" ID="CodeStyleCheckerPlugin.cancelStyleBatchCheck"></a>
<h4>CodeStyleCheckerPlugin.cancelStyleBatchCheck</h4>
<b>cancelStyleBatchCheck</b>(<i></i>)
-
<p>
Public method to cancel all batch jobs.
</p>
+
<a NAME="CodeStyleCheckerPlugin.deactivate" ID="CodeStyleCheckerPlugin.deactivate"></a>
<h4>CodeStyleCheckerPlugin.deactivate</h4>
<b>deactivate</b>(<i></i>)
-
<p>
Public method to deactivate this plugin.
</p>
+
<a NAME="CodeStyleCheckerPlugin.serviceErrorPy3" ID="CodeStyleCheckerPlugin.serviceErrorPy3"></a>
<h4>CodeStyleCheckerPlugin.serviceErrorPy3</h4>
<b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>)
-
<p>
Public slot handling service errors for Python 3.
</p>
+
<dl>
<dt><i>fx</i> (str)</dt>
@@ -408,10 +407,10 @@
<a NAME="CodeStyleCheckerPlugin.styleBatchCheck" ID="CodeStyleCheckerPlugin.styleBatchCheck"></a>
<h4>CodeStyleCheckerPlugin.styleBatchCheck</h4>
<b>styleBatchCheck</b>(<i>argumentsList</i>)
-
<p>
Public method to prepare a style check on multiple Python source files.
</p>
+
<dl>
<dt><i>argumentsList</i> (list of tuple of (str, str, list))</dt>
@@ -424,10 +423,10 @@
<a NAME="CodeStyleCheckerPlugin.styleCheck" ID="CodeStyleCheckerPlugin.styleCheck"></a>
<h4>CodeStyleCheckerPlugin.styleCheck</h4>
<b>styleCheck</b>(<i>lang, filename, source, args</i>)
-
<p>
Public method to prepare a style check on one Python source file.
</p>
+
<dl>
<dt><i>lang</i> (str or None)</dt>
@@ -455,4 +454,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
