diff -r 0b38613388c9 -r 8349fd3f8802 Documentation/Source/eric6.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheck.html
--- a/Documentation/Source/eric6.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheck.html Wed Apr 22 19:53:58 2015 +0200
+++ b/Documentation/Source/eric6.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheck.html Wed Apr 22 19:54:47 2015 +0200
@@ -34,20 +34,64 @@
<h3>Functions</h3>
<table>
<tr>
+<td><a href="#__syntaxAndPyflakesCheck">__syntaxAndPyflakesCheck</a></td>
+<td>Function to compile one Python source file to Python bytecode and to perform a pyflakes check.</td>
+</tr><tr>
<td><a href="#extractLineFlags">extractLineFlags</a></td>
<td>Function to extract flags starting and ending with '__' from a line comment.</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="#normalizeCode">normalizeCode</a></td>
<td>Function to normalize the given code.</td>
</tr><tr>
+<td><a href="#syntaxAndPyflakesBatchCheck">syntaxAndPyflakesBatchCheck</a></td>
+<td>Module function to check syntax for a batch of files.</td>
+</tr><tr>
<td><a href="#syntaxAndPyflakesCheck">syntaxAndPyflakesCheck</a></td>
<td>Function to compile one Python source file to Python bytecode and to perform a pyflakes check.</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="__syntaxAndPyflakesCheck" ID="__syntaxAndPyflakesCheck"></a>
+<h2>__syntaxAndPyflakesCheck</h2>
+<b>__syntaxAndPyflakesCheck</b>(<i>filename, codestring, checkFlakes=True, ignoreStarImportWarnings=False</i>)
+<p>
+ Function to compile one Python source file to Python bytecode
+ and to perform a pyflakes check.
+</p><dl>
+<dt><i>filename</i></dt>
+<dd>
+source filename (string)
+</dd><dt><i>codestring</i></dt>
+<dd>
+string containing the code to compile (string)
+</dd><dt><i>checkFlakes=</i></dt>
+<dd>
+flag indicating to do a pyflakes check (boolean)
+</dd><dt><i>ignoreStarImportWarnings=</i></dt>
+<dd>
+flag indicating to
+ ignore 'star import' warnings (boolean)
+</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="extractLineFlags" ID="extractLineFlags"></a>
<h2>extractLineFlags</h2>
<b>extractLineFlags</b>(<i>line, startComment="</i>)
@@ -73,6 +117,19 @@
</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>)
@@ -104,6 +161,30 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
+<a NAME="syntaxAndPyflakesBatchCheck" ID="syntaxAndPyflakesBatchCheck"></a>
+<h2>syntaxAndPyflakesBatchCheck</h2>
+<b>syntaxAndPyflakesBatchCheck</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="syntaxAndPyflakesCheck" ID="syntaxAndPyflakesCheck"></a>
<h2>syntaxAndPyflakesCheck</h2>
<b>syntaxAndPyflakesCheck</b>(<i>filename, codestring, checkFlakes=True, ignoreStarImportWarnings=False</i>)
@@ -135,5 +216,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
