--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.jsCheckSyntax.html Fri Mar 31 13:39:51 2023 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,200 +0,0 @@ -<!DOCTYPE html> -<html><head> -<title>eric7.Plugins.CheckerPlugins.SyntaxChecker.jsCheckSyntax</title> -<meta charset="UTF-8"> -<link rel="stylesheet" href="styles.css"> -</head> -<body> -<a NAME="top" ID="top"></a> -<h1>eric7.Plugins.CheckerPlugins.SyntaxChecker.jsCheckSyntax</h1> - -<p> -Module implementing the syntax check for JavaScript. -</p> -<h3>Global Attributes</h3> - -<table> -<tr><td>None</td></tr> -</table> -<h3>Classes</h3> - -<table> -<tr><td>None</td></tr> -</table> -<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="#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="#workerTask">workerTask</a></td> -<td>Module function acting as the parallel worker for the syntax 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>Return:</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>Return:</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>) - -<p> - Initialize the service and return the entry point. -</p> -<dl> -<dt>Return:</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="jsSyntaxBatchCheck" ID="jsSyntaxBatchCheck"></a> -<h2>jsSyntaxBatchCheck</h2> -<b>jsSyntaxBatchCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>) - -<p> - Module function to check syntax for a batch of files. -</p> -<dl> - -<dt><i>argumentsList</i> (list)</dt> -<dd> -list of arguments tuples as given for jsSyntaxCheck -</dd> -<dt><i>send</i> (func)</dt> -<dd> -reference to send function -</dd> -<dt><i>fx</i> (str)</dt> -<dd> -registered service name -</dd> -<dt><i>cancelled</i> (func)</dt> -<dd> -reference to function checking for a cancellation -</dd> -<dt><i>maxProcesses</i> (int)</dt> -<dd> -number of processes to be used -</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> - -<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>Return:</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="workerTask" ID="workerTask"></a> -<h2>workerTask</h2> -<b>workerTask</b>(<i>inputQueue, outputQueue</i>) - -<p> - Module function acting as the parallel worker for the syntax check. -</p> -<dl> - -<dt><i>inputQueue</i></dt> -<dd> -input queue (multiprocessing.Queue) -</dd> -<dt><i>outputQueue</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