Mercurial Repositories > eric / file diff

diff: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService.html

src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService.html

branch
eric7
changeset 10341
3fdffd9cc21d
parent 9925
a267ac36dd69
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService.html	Fri Nov 24 14:59:26 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService.html	Sat Nov 25 18:19:21 2023 +0100
@@ -164,19 +164,25 @@
 </p>
 <dl>
 
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
-of the sourcefile (str)
+of the sourcefile
 </dd>
-<dt><i>source</i></dt>
+<dt><i>source</i> (str)</dt>
 <dd>
-code of the file (str)
+code of the file
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-language of the file or None if not found (str or None)
+language of the file or None if not found
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str or None
 </dd>
 </dl>
 <a NAME="SyntaxCheckService.__serviceError" ID="SyntaxCheckService.__serviceError"></a>
@@ -188,13 +194,13 @@
 </p>
 <dl>
 
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-file name (string)
+file name
 </dd>
-<dt><i>msg</i></dt>
+<dt><i>msg</i> (str)</dt>
 <dd>
-message text (string)
+message text
 </dd>
 </dl>
 <a NAME="SyntaxCheckService.addLanguage" ID="SyntaxCheckService.addLanguage"></a>
@@ -206,40 +212,39 @@
 </p>
 <dl>
 
-<dt><i>lang</i></dt>
+<dt><i>lang</i> (str)</dt>
 <dd>
-new language to check syntax (str)
+new language to check syntax
 </dd>
-<dt><i>env</i></dt>
+<dt><i>env</i> (str)</dt>
 <dd>
-the environment in which the checker is implemented (str)
+the environment in which the checker is implemented
 </dd>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
-full path to the module (str)
+full path to the module
 </dd>
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
 <dd>
-name to import (str)
+name to import
 </dd>
-<dt><i>getArgs</i></dt>
+<dt><i>getArgs</i> (function)</dt>
 <dd>
 function to collect the required arguments to call the
-            syntax checker on client side (function)
+            syntax checker on client side
 </dd>
-<dt><i>getExt</i></dt>
+<dt><i>getExt</i> (function)</dt>
 <dd>
 function that returns the supported file extensions of
-            the syntax checker (function)
+            the syntax checker
 </dd>
-<dt><i>callback</i></dt>
+<dt><i>callback</i> (function)</dt>
 <dd>
-function on service response (function)
+function on service response
 </dd>
-<dt><i>onError</i></dt>
+<dt><i>onError</i> (function)</dt>
 <dd>
 callback function if client or service isn't available
-            (function)
 </dd>
 </dl>
 <a NAME="SyntaxCheckService.batchJobDone" ID="SyntaxCheckService.batchJobDone"></a>
@@ -251,13 +256,13 @@
 </p>
 <dl>
 
-<dt><i>fx</i></dt>
+<dt><i>fx</i> (str)</dt>
 <dd>
-service name (string)
+service name
 </dd>
-<dt><i>lang</i></dt>
+<dt><i>lang</i> (str)</dt>
 <dd>
-language (string)
+language
 </dd>
 </dl>
 <a NAME="SyntaxCheckService.cancelSyntaxBatchCheck" ID="SyntaxCheckService.cancelSyntaxBatchCheck"></a>
@@ -278,7 +283,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-set of all supported file extensions (set of str)
+set of all supported file extensions
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+set of str
 </dd>
 </dl>
 <a NAME="SyntaxCheckService.getLanguages" ID="SyntaxCheckService.getLanguages"></a>
@@ -291,7 +302,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of languanges supported (list of str)
+list of languanges supported
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="SyntaxCheckService.removeLanguage" ID="SyntaxCheckService.removeLanguage"></a>
@@ -303,9 +320,9 @@
 </p>
 <dl>
 
-<dt><i>lang</i></dt>
+<dt><i>lang</i> (str)</dt>
 <dd>
-language to remove (str)
+language to remove
 </dd>
 </dl>
 <a NAME="SyntaxCheckService.serviceErrorJSON" ID="SyntaxCheckService.serviceErrorJSON"></a>
@@ -317,21 +334,21 @@
 </p>
 <dl>
 
-<dt><i>fx</i></dt>
+<dt><i>fx</i> (str)</dt>
 <dd>
-service name (string)
+service name
 </dd>
-<dt><i>lang</i></dt>
+<dt><i>lang</i> (str)</dt>
 <dd>
-language (string)
+language
 </dd>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-file name (string)
+file name
 </dd>
-<dt><i>msg</i></dt>
+<dt><i>msg</i> (str)</dt>
 <dd>
-message text (string)
+message text
 </dd>
 </dl>
 <a NAME="SyntaxCheckService.serviceErrorJavaScript" ID="SyntaxCheckService.serviceErrorJavaScript"></a>
@@ -343,21 +360,21 @@
 </p>
 <dl>
 
-<dt><i>fx</i></dt>
+<dt><i>fx</i> (str)</dt>
 <dd>
-service name (string)
+service name
 </dd>
-<dt><i>lang</i></dt>
+<dt><i>lang</i> (str)</dt>
 <dd>
-language (string)
+language
 </dd>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-file name (string)
+file name
 </dd>
-<dt><i>msg</i></dt>
+<dt><i>msg</i> (str)</dt>
 <dd>
-message text (string)
+message text
 </dd>
 </dl>
 <a NAME="SyntaxCheckService.serviceErrorPy3" ID="SyntaxCheckService.serviceErrorPy3"></a>
@@ -369,21 +386,21 @@
 </p>
 <dl>
 
-<dt><i>fx</i></dt>
+<dt><i>fx</i> (str)</dt>
 <dd>
-service name (string)
+service name
 </dd>
-<dt><i>lang</i></dt>
+<dt><i>lang</i> (str)</dt>
 <dd>
-language (string)
+language
 </dd>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-file name (string)
+file name
 </dd>
-<dt><i>msg</i></dt>
+<dt><i>msg</i> (str)</dt>
 <dd>
-message text (string)
+message text
 </dd>
 </dl>
 <a NAME="SyntaxCheckService.serviceErrorTOML" ID="SyntaxCheckService.serviceErrorTOML"></a>
@@ -395,21 +412,21 @@
 </p>
 <dl>
 
-<dt><i>fx</i></dt>
+<dt><i>fx</i> (str)</dt>
 <dd>
-service name (string)
+service name
 </dd>
-<dt><i>lang</i></dt>
+<dt><i>lang</i> (str)</dt>
 <dd>
-language (string)
+language
 </dd>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-file name (string)
+file name
 </dd>
-<dt><i>msg</i></dt>
+<dt><i>msg</i> (str)</dt>
 <dd>
-message text (string)
+message text
 </dd>
 </dl>
 <a NAME="SyntaxCheckService.serviceErrorYAML" ID="SyntaxCheckService.serviceErrorYAML"></a>
@@ -421,21 +438,21 @@
 </p>
 <dl>
 
-<dt><i>fx</i></dt>
+<dt><i>fx</i> (str)</dt>
 <dd>
-service name (string)
+service name
 </dd>
-<dt><i>lang</i></dt>
+<dt><i>lang</i> (str)</dt>
 <dd>
-language (string)
+language
 </dd>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-file name (string)
+file name
 </dd>
-<dt><i>msg</i></dt>
+<dt><i>msg</i> (str)</dt>
 <dd>
-message text (string)
+message text
 </dd>
 </dl>
 <a NAME="SyntaxCheckService.syntaxBatchCheck" ID="SyntaxCheckService.syntaxBatchCheck"></a>
@@ -447,10 +464,10 @@
 </p>
 <dl>
 
-<dt><i>argumentsList</i></dt>
+<dt><i>argumentsList</i> (list of tuples of (str, str))</dt>
 <dd>
-list of arguments tuples with each tuple
-            containing filename and source (string, string)
+list of argument tuples with each tuple
+            containing filename and source
 </dd>
 </dl>
 <a NAME="SyntaxCheckService.syntaxCheck" ID="SyntaxCheckService.syntaxCheck"></a>

Mercurial Repository: eric

eric ide

mercurial