diff -r 8d4e498a7af8 -r ff8a3e769fca Documentation/Source/eric6.Plugins.CheckerPlugins.Tabnanny.Tabnanny.html --- a/Documentation/Source/eric6.Plugins.CheckerPlugins.Tabnanny.Tabnanny.html Thu Apr 23 20:11:44 2015 +0200 +++ b/Documentation/Source/eric6.Plugins.CheckerPlugins.Tabnanny.Tabnanny.html Fri Apr 24 18:41:06 2015 +0200 @@ -57,17 +57,29 @@ <h3>Functions</h3> <table> <tr> +<td><a href="#__check">__check</a></td> +<td>Private function to check one Python source file for whitespace related problems.</td> +</tr><tr> +<td><a href="#batchCheck">batchCheck</a></td> +<td>Module function to check a batch of files for whitespace related problems.</td> +</tr><tr> <td><a href="#check">check</a></td> <td>Private function to check one Python source file for whitespace related problems.</td> </tr><tr> <td><a href="#format_witnesses">format_witnesses</a></td> <td>Function to format the witnesses as a readable string.</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="#process_tokens">process_tokens</a></td> <td>Function processing all tokens generated by a tokenizer run.</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 /> @@ -312,6 +324,54 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> +<a NAME="__check" ID="__check"></a> +<h2>__check</h2> +<b>__check</b>(<i>file, text=""</i>) +<p> + Private function to check one Python source file for whitespace related + problems. +</p><dl> +<dt><i>file</i></dt> +<dd> +source filename (string) +</dd><dt><i>text</i></dt> +<dd> +source text (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +A tuple indicating status (True = an error was found), the + filename, the linenumber and the error message + (boolean, string, string). The values are only + valid, if the status is True. +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="batchCheck" ID="batchCheck"></a> +<h2>batchCheck</h2> +<b>batchCheck</b>(<i>argumentsList, send, fx, cancelled</i>) +<p> + Module function to check a batch of files for whitespace related problems. +</p><dl> +<dt><i>argumentsList</i></dt> +<dd> +list of arguments tuples as given for check +</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="check" ID="check"></a> <h2>check</h2> <b>check</b>(<i>file, text=""</i>) @@ -355,6 +415,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>) @@ -385,5 +458,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