Mercurial Repositories > eric / file diff

--- a/Documentation/Source/eric5.Plugins.PluginCodeStyleChecker.html	Sun Jan 05 23:22:17 2014 +0100
+++ b/Documentation/Source/eric5.Plugins.PluginCodeStyleChecker.html	Sun Mar 30 22:00:14 2014 +0200
@@ -43,7 +43,14 @@
 <h2>CodeStyleCheckerPlugin</h2>
 <p>
     Class implementing the code style checker plug-in.
-</p>
+</p><h3>Signals</h3>
+<dl>
+<dt>styleChecked(str, dict, int, list)</dt>
+<dd>
+emited when the style check was
+        done.
+</dd>
+</dl>
 <h3>Derived from</h3>
 QObject
 <h3>Class Attributes</h3>
@@ -87,11 +94,17 @@
 <td><a href="#CodeStyleCheckerPlugin.__projectShowMenu">__projectShowMenu</a></td>
 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td>
 </tr><tr>
+<td><a href="#CodeStyleCheckerPlugin.__translateStyleCheck">__translateStyleCheck</a></td>
+<td>Privat slot called after perfoming a style check on one file.</td>
+</tr><tr>
 <td><a href="#CodeStyleCheckerPlugin.activate">activate</a></td>
 <td>Public method to activate this plugin.</td>
 </tr><tr>
 <td><a href="#CodeStyleCheckerPlugin.deactivate">deactivate</a></td>
 <td>Public method to deactivate this plugin.</td>
+</tr><tr>
+<td><a href="#CodeStyleCheckerPlugin.styleCheck">styleCheck</a></td>
+<td>Method to prepare a style check on one Python source file in another task.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
@@ -195,6 +208,24 @@
 <dd>
 reference to the menu (QMenu)
 </dd>
+</dl><a NAME="CodeStyleCheckerPlugin.__translateStyleCheck" ID="CodeStyleCheckerPlugin.__translateStyleCheck"></a>
+<h4>CodeStyleCheckerPlugin.__translateStyleCheck</h4>
+<b>__translateStyleCheck</b>(<i>fn, codeStyleCheckerStats, results</i>)
+<p>
+        Privat slot called after perfoming a style check on one file.
+</p><dl>
+<dt><i>fn</i></dt>
+<dd>
+filename of the just checked file (str)
+</dd><dt><i>codeStyleCheckerStats</i></dt>
+<dd>
+stats of style and name check (dict)
+</dd><dt><i>results</i></dt>
+<dd>
+tuple for each found violation of style (tuple of
+            lineno (int), position (int), text (str), fixed (bool),
+            autofixing (bool), fixedMsg (str))
+</dd>
 </dl><a NAME="CodeStyleCheckerPlugin.activate" ID="CodeStyleCheckerPlugin.activate"></a>
 <h4>CodeStyleCheckerPlugin.activate</h4>
 <b>activate</b>(<i></i>)
@@ -210,7 +241,32 @@
 <b>deactivate</b>(<i></i>)
 <p>
         Public method to deactivate this plugin.
-</p>
+</p><a NAME="CodeStyleCheckerPlugin.styleCheck" ID="CodeStyleCheckerPlugin.styleCheck"></a>
+<h4>CodeStyleCheckerPlugin.styleCheck</h4>
+<b>styleCheck</b>(<i>lang, filename, source, args</i>)
+<p>
+        Method to prepare a style check on one Python source file in another
+        task.
+</p><dl>
+<dt><i>lang</i></dt>
+<dd>
+language of the file or None to determine by internal
+            algorithm (str or None)
+</dd><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))
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file