Mercurial Repositories > eric / file diff

--- a/Documentation/Source/eric6.Plugins.CheckerPlugins.SyntaxChecker.jsCheckSyntax.html	Wed Apr 22 19:53:58 2015 +0200
+++ b/Documentation/Source/eric6.Plugins.CheckerPlugins.SyntaxChecker.jsCheckSyntax.html	Wed Apr 22 19:54:47 2015 +0200
@@ -34,17 +34,66 @@
 <h3>Functions</h3>
 <table>
 <tr>
+<td><a href="#__jsSyntaxCheck">__jsSyntaxCheck</a></td>
+<td>Function to check a Javascript source file for syntax errors.</td>
+</tr><tr>
+<td><a href="#initBatchService">initBatchService</a></td>
+<td>Initialize the batch service and return the entry point.</td>
+</tr><tr>
 <td><a href="#initService">initService</a></td>
 <td>Initialize the service and return the entry point.</td>
 </tr><tr>
-<td><a href="#jsCheckSyntax">jsCheckSyntax</a></td>
+<td><a href="#jsSyntaxBatchCheck">jsSyntaxBatchCheck</a></td>
+<td>Module function to check syntax for a batch of files.</td>
+</tr><tr>
+<td><a href="#jsSyntaxCheck">jsSyntaxCheck</a></td>
 <td>Function to check a Javascript source file for syntax errors.</td>
 </tr><tr>
 <td><a href="#normalizeCode">normalizeCode</a></td>
 <td>Function to normalize the given code.</td>
+</tr><tr>
+<td><a href="#worker">worker</a></td>
+<td>Module function acting as the parallel worker for the style check.</td>
 </tr>
 </table>
 <hr /><hr />
+<a NAME="__jsSyntaxCheck" ID="__jsSyntaxCheck"></a>
+<h2>__jsSyntaxCheck</h2>
+<b>__jsSyntaxCheck</b>(<i>file, codestring</i>)
+<p>
+    Function to check a Javascript source file for syntax errors.
+</p><dl>
+<dt><i>file</i></dt>
+<dd>
+source filename (string)
+</dd><dt><i>codestring</i></dt>
+<dd>
+string containing the code to check (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+dictionary with the keys 'error' and 'warnings' which
+            hold a list containing details about the error/ warnings
+            (file name, line number, column, codestring (only at syntax
+            errors), the message, a list with arguments for the message)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<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>Returns:</dt>
+<dd>
+the entry point for the background client (function)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
 <a NAME="initService" ID="initService"></a>
 <h2>initService</h2>
 <b>initService</b>(<i></i>)
@@ -58,9 +107,33 @@
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
-<a NAME="jsCheckSyntax" ID="jsCheckSyntax"></a>
-<h2>jsCheckSyntax</h2>
-<b>jsCheckSyntax</b>(<i>file, codestring</i>)
+<a NAME="jsSyntaxBatchCheck" ID="jsSyntaxBatchCheck"></a>
+<h2>jsSyntaxBatchCheck</h2>
+<b>jsSyntaxBatchCheck</b>(<i>argumentsList, send, fx, cancelled</i>)
+<p>
+    Module function to check syntax for a batch of files.
+</p><dl>
+<dt><i>argumentsList</i></dt>
+<dd>
+list of arguments tuples as given for
+        syntaxAndPyflakesCheck
+</dd><dt><i>send</i></dt>
+<dd>
+reference to send function (function)
+</dd><dt><i>fx</i></dt>
+<dd>
+registered service name (string)
+</dd><dt><i>cancelled</i></dt>
+<dd>
+reference to function checking for a cancellation
+        (function)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="jsSyntaxCheck" ID="jsSyntaxCheck"></a>
+<h2>jsSyntaxCheck</h2>
+<b>jsSyntaxCheck</b>(<i>file, codestring</i>)
 <p>
     Function to check a Javascript source file for syntax errors.
 </p><dl>
@@ -99,5 +172,21 @@
 </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>input, output</i>)
+<p>
+    Module function acting as the parallel worker for the style check.
+</p><dl>
+<dt><i>input</i></dt>
+<dd>
+input queue (multiprocessing.Queue)
+</dd><dt><i>output</i></dt>
+<dd>
+output queue (multiprocessing.Queue)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file