Mercurial Repositories > eric / file diff

--- a/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html	Tue Apr 14 19:51:10 2015 +0200
+++ b/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html	Thu Apr 16 19:58:27 2015 +0200
@@ -37,14 +37,26 @@
 <h3>Functions</h3>
 <table>
 <tr>
+<td><a href="#__checkCodeStyle">__checkCodeStyle</a></td>
+<td>Private module function to perform the code style check and/or fix found errors.</td>
+</tr><tr>
+<td><a href="#codeStyleBatchCheck">codeStyleBatchCheck</a></td>
+<td>Module function to check code style for a batch of files.</td>
+</tr><tr>
 <td><a href="#codeStyleCheck">codeStyleCheck</a></td>
 <td>Do the code style check and/ or fix found errors.</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="#worker">worker</a></td>
+<td>Module function acting as the parallel worker for the style check.</td>
 </tr>
 </table>
 <hr /><hr />
@@ -117,6 +129,56 @@
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
+<a NAME="__checkCodeStyle" ID="__checkCodeStyle"></a>
+<h2>__checkCodeStyle</h2>
+<b>__checkCodeStyle</b>(<i>filename, source, args</i>)
+<p>
+    Private module function to perform the code style check and/or fix
+    found errors.
+</p><dl>
+<dt><i>filename</i></dt>
+<dd>
+source filename (string)
+</dd><dt><i>source</i></dt>
+<dd>
+string containing the code to check (string)
+</dd><dt><i>args</i></dt>
+<dd>
+arguments used by the codeStyleCheck function (list of
+        excludeMessages (str), includeMessages (str), repeatMessages
+        (bool), fixCodes (str), noFixCodes (str), fixIssues (bool),
+        maxLineLength (int), hangClosing (bool), docType (str), errors
+        (list of str), eol (str), encoding (str), backup (bool))
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+tuple of stats (dict) and results (tuple for each found violation
+        of style (tuple of lineno (int), position (int), text (str), ignored
+            (bool), fixed (bool), autofixing (bool), fixedMsg (str)))
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="codeStyleBatchCheck" ID="codeStyleBatchCheck"></a>
+<h2>codeStyleBatchCheck</h2>
+<b>codeStyleBatchCheck</b>(<i>argumentsList, send, fx</i>)
+<p>
+    Module function to check code style for a batch of files.
+</p><dl>
+<dt><i>argumentsList</i></dt>
+<dd>
+list of arguments tuples as given for codeStyleCheck
+</dd><dt><i>send</i></dt>
+<dd>
+reference to send method
+</dd><dt><i>fx</i></dt>
+<dd>
+registered service name (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
 <a NAME="codeStyleCheck" ID="codeStyleCheck"></a>
 <h2>codeStyleCheck</h2>
 <b>codeStyleCheck</b>(<i>filename, source, args</i>)
@@ -172,6 +234,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>)
@@ -184,5 +259,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