Mercurial Repositories > eric / file diff

--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog.html	Sun Jan 05 22:45:29 2014 +0100
+++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog.html	Wed Jan 15 22:55:52 2014 +0100
@@ -69,9 +69,15 @@
 <td><a href="#SyntaxCheckerDialog.__finish">__finish</a></td>
 <td>Private slot called when the syntax check finished or the user pressed the button.</td>
 </tr><tr>
+<td><a href="#SyntaxCheckerDialog.__processResult">__processResult</a></td>
+<td>Slot to display the reported messages.</td>
+</tr><tr>
 <td><a href="#SyntaxCheckerDialog.__resort">__resort</a></td>
 <td>Private method to resort the tree.</td>
 </tr><tr>
+<td><a href="#SyntaxCheckerDialog.check">check</a></td>
+<td>Start a check for one file.</td>
+</tr><tr>
 <td><a href="#SyntaxCheckerDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
 <td>Private slot called by a button of the button box clicked.</td>
 </tr><tr>
@@ -141,12 +147,60 @@
 <p>
         Private slot called when the syntax check finished or the user
         pressed the button.
-</p><a NAME="SyntaxCheckerDialog.__resort" ID="SyntaxCheckerDialog.__resort"></a>
+</p><a NAME="SyntaxCheckerDialog.__processResult" ID="SyntaxCheckerDialog.__processResult"></a>
+<h4>SyntaxCheckerDialog.__processResult</h4>
+<b>__processResult</b>(<i>fn, nok, fname, line, index, code, error, warnings</i>)
+<p>
+        Slot to display the reported messages.
+</p><p>
+        If checkFlakes is True, warnings contains a list of strings containing
+        the warnings (marker, file name, line number, message)
+        The values are only valid, if nok is False.
+</p><dl>
+<dt><i>fn</i></dt>
+<dd>
+filename of the checked file (str)
+</dd><dt><i>nok</i></dt>
+<dd>
+flag if an error in the source was found (boolean)
+</dd><dt><i>fname</i></dt>
+<dd>
+filename of the checked file (str)  # TODO: remove dubl.
+</dd><dt><i>line</i></dt>
+<dd>
+number where the error occured (int)
+</dd><dt><i>index</i></dt>
+<dd>
+the column where the error occured (int)
+</dd><dt><i>code</i></dt>
+<dd>
+the part of the code where the error occured (str)
+</dd><dt><i>error</i></dt>
+<dd>
+the name of the error (str)
+</dd><dt><i>warnings</i></dt>
+<dd>
+a list of strings containing the warnings
+            (marker, file name, line number, col, message)
+</dd>
+</dl><a NAME="SyntaxCheckerDialog.__resort" ID="SyntaxCheckerDialog.__resort"></a>
 <h4>SyntaxCheckerDialog.__resort</h4>
 <b>__resort</b>(<i></i>)
 <p>
         Private method to resort the tree.
-</p><a NAME="SyntaxCheckerDialog.on_buttonBox_clicked" ID="SyntaxCheckerDialog.on_buttonBox_clicked"></a>
+</p><a NAME="SyntaxCheckerDialog.check" ID="SyntaxCheckerDialog.check"></a>
+<h4>SyntaxCheckerDialog.check</h4>
+<b>check</b>(<i>codestring=''</i>)
+<p>
+        Start a check for one file.
+</p><p>
+        The results are reported to the __processResult slot.
+</p><dl>
+<dt><i>codestring=</i></dt>
+<dd>
+optional sourcestring (str)
+</dd>
+</dl><a NAME="SyntaxCheckerDialog.on_buttonBox_clicked" ID="SyntaxCheckerDialog.on_buttonBox_clicked"></a>
 <h4>SyntaxCheckerDialog.on_buttonBox_clicked</h4>
 <b>on_buttonBox_clicked</b>(<i>button</i>)
 <p>
@@ -205,7 +259,7 @@
 </dd><dt><i>codestring</i></dt>
 <dd>
 string containing the code to be checked (string).
-            If this is given, file must be a single file name.
+            If this is given, fn must be a single file name.
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>