diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService.html
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,35 +7,33 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService</h1>
-
<p>
Module implementing an interface to add different languages to do a syntax
check.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#SyntaxCheckService">SyntaxCheckService</a></td>
<td>Implement the syntax check service.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="SyntaxCheckService" ID="SyntaxCheckService"></a>
<h2>SyntaxCheckService</h2>
-
<p>
Implement the syntax check service.
</p>
@@ -44,6 +42,7 @@
and support of an extra checker module on the client side which has to
connect directly to the background service.
</p>
+
<h3>Signals</h3>
<dl>
@@ -64,19 +63,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="#SyntaxCheckService.__init__">SyntaxCheckService</a></td>
<td>Constructor</td>
@@ -142,26 +139,27 @@
<td>Public method to prepare a syntax check of one source file.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="SyntaxCheckService.__init__" ID="SyntaxCheckService.__init__"></a>
<h4>SyntaxCheckService (Constructor)</h4>
<b>SyntaxCheckService</b>(<i></i>)
-
<p>
Constructor
</p>
+
<a NAME="SyntaxCheckService.__determineLanguage" ID="SyntaxCheckService.__determineLanguage"></a>
<h4>SyntaxCheckService.__determineLanguage</h4>
<b>__determineLanguage</b>(<i>filename, source</i>)
-
<p>
Private method to determine the language of the file.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -188,10 +186,10 @@
<a NAME="SyntaxCheckService.__serviceError" ID="SyntaxCheckService.__serviceError"></a>
<h4>SyntaxCheckService.__serviceError</h4>
<b>__serviceError</b>(<i>fn, msg</i>)
-
<p>
Private slot handling service errors.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -206,10 +204,10 @@
<a NAME="SyntaxCheckService.addLanguage" ID="SyntaxCheckService.addLanguage"></a>
<h4>SyntaxCheckService.addLanguage</h4>
<b>addLanguage</b>(<i>lang, env, path, module, getArgs, getExt, callback, onError</i>)
-
<p>
Public method to register a new language to the supported languages.
</p>
+
<dl>
<dt><i>lang</i> (str)</dt>
@@ -250,10 +248,10 @@
<a NAME="SyntaxCheckService.batchJobDone" ID="SyntaxCheckService.batchJobDone"></a>
<h4>SyntaxCheckService.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>
@@ -268,18 +266,18 @@
<a NAME="SyntaxCheckService.cancelSyntaxBatchCheck" ID="SyntaxCheckService.cancelSyntaxBatchCheck"></a>
<h4>SyntaxCheckService.cancelSyntaxBatchCheck</h4>
<b>cancelSyntaxBatchCheck</b>(<i></i>)
-
<p>
Public method to cancel all batch jobs.
</p>
+
<a NAME="SyntaxCheckService.getExtensions" ID="SyntaxCheckService.getExtensions"></a>
<h4>SyntaxCheckService.getExtensions</h4>
<b>getExtensions</b>(<i></i>)
-
<p>
Public method to return all supported file extensions for the
syntax checker dialog.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -295,10 +293,10 @@
<a NAME="SyntaxCheckService.getLanguages" ID="SyntaxCheckService.getLanguages"></a>
<h4>SyntaxCheckService.getLanguages</h4>
<b>getLanguages</b>(<i></i>)
-
<p>
Public method to return the supported language names.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -314,10 +312,10 @@
<a NAME="SyntaxCheckService.removeLanguage" ID="SyntaxCheckService.removeLanguage"></a>
<h4>SyntaxCheckService.removeLanguage</h4>
<b>removeLanguage</b>(<i>lang</i>)
-
<p>
Public method to remove the language from syntax check.
</p>
+
<dl>
<dt><i>lang</i> (str)</dt>
@@ -328,10 +326,10 @@
<a NAME="SyntaxCheckService.serviceErrorJSON" ID="SyntaxCheckService.serviceErrorJSON"></a>
<h4>SyntaxCheckService.serviceErrorJSON</h4>
<b>serviceErrorJSON</b>(<i>fx, lang, fn, msg</i>)
-
<p>
Public method handling service errors for JSON.
</p>
+
<dl>
<dt><i>fx</i> (str)</dt>
@@ -354,10 +352,10 @@
<a NAME="SyntaxCheckService.serviceErrorJavaScript" ID="SyntaxCheckService.serviceErrorJavaScript"></a>
<h4>SyntaxCheckService.serviceErrorJavaScript</h4>
<b>serviceErrorJavaScript</b>(<i>fx, lang, fn, msg</i>)
-
<p>
Public method handling service errors for JavaScript.
</p>
+
<dl>
<dt><i>fx</i> (str)</dt>
@@ -380,10 +378,10 @@
<a NAME="SyntaxCheckService.serviceErrorPy3" ID="SyntaxCheckService.serviceErrorPy3"></a>
<h4>SyntaxCheckService.serviceErrorPy3</h4>
<b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>)
-
<p>
Public method handling service errors for Python 3.
</p>
+
<dl>
<dt><i>fx</i> (str)</dt>
@@ -406,10 +404,10 @@
<a NAME="SyntaxCheckService.serviceErrorTOML" ID="SyntaxCheckService.serviceErrorTOML"></a>
<h4>SyntaxCheckService.serviceErrorTOML</h4>
<b>serviceErrorTOML</b>(<i>fx, lang, fn, msg</i>)
-
<p>
Public method handling service errors for TOML.
</p>
+
<dl>
<dt><i>fx</i> (str)</dt>
@@ -432,10 +430,10 @@
<a NAME="SyntaxCheckService.serviceErrorYAML" ID="SyntaxCheckService.serviceErrorYAML"></a>
<h4>SyntaxCheckService.serviceErrorYAML</h4>
<b>serviceErrorYAML</b>(<i>fx, lang, fn, msg</i>)
-
<p>
Public method handling service errors for YAML.
</p>
+
<dl>
<dt><i>fx</i> (str)</dt>
@@ -458,10 +456,10 @@
<a NAME="SyntaxCheckService.syntaxBatchCheck" ID="SyntaxCheckService.syntaxBatchCheck"></a>
<h4>SyntaxCheckService.syntaxBatchCheck</h4>
<b>syntaxBatchCheck</b>(<i>argumentsList</i>)
-
<p>
Public method to prepare a syntax check on multiple source files.
</p>
+
<dl>
<dt><i>argumentsList</i> (list of tuples of (str, str))</dt>
@@ -473,10 +471,10 @@
<a NAME="SyntaxCheckService.syntaxCheck" ID="SyntaxCheckService.syntaxCheck"></a>
<h4>SyntaxCheckService.syntaxCheck</h4>
<b>syntaxCheck</b>(<i>lang, filename, source, *args</i>)
-
<p>
Public method to prepare a syntax check of one source file.
</p>
+
<dl>
<dt><i>lang</i> (str or None)</dt>
@@ -499,4 +497,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
