Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog.html	Fri Nov 11 17:49:06 2022 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog.html	Sat Nov 12 17:49:08 2022 +0100
@@ -122,6 +122,10 @@
 <td><a href="#SyntaxCheckerDialog.start">start</a></td>
 <td>Public slot to start the syntax check.</td>
 </tr>
+<tr>
+<td><a href="#SyntaxCheckerDialog.startForBrowser">startForBrowser</a></td>
+<td>Public slot to start the syntax check for the project sources browser.</td>
+</tr>
 </table>
 <h3>Static Methods</h3>
 
@@ -138,9 +142,9 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-The parent widget. (QWidget)
+reference to the parent widget
 </dd>
 </dl>
 <a NAME="SyntaxCheckerDialog.__batchFinished" ID="SyntaxCheckerDialog.__batchFinished"></a>
@@ -160,9 +164,9 @@
 </p>
 <dl>
 
-<dt><i>files</i></dt>
+<dt><i>files</i> (list of str)</dt>
 <dd>
-list of files to be checked (list of string)
+list of files to be checked
 </dd>
 </dl>
 <a NAME="SyntaxCheckerDialog.__createErrorItem" ID="SyntaxCheckerDialog.__createErrorItem"></a>
@@ -192,29 +196,29 @@
 </p>
 <dl>
 
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
-file name of file (string)
+file name of file
 </dd>
-<dt><i>line</i></dt>
+<dt><i>line</i> (int or str)</dt>
 <dd>
-line number of faulty source (integer or string)
+line number of faulty source
 </dd>
-<dt><i>index</i></dt>
+<dt><i>index</i> (int)</dt>
 <dd>
-index number of fault (integer)
+index number of fault
 </dd>
-<dt><i>error</i></dt>
+<dt><i>error</i> (str)</dt>
 <dd>
-error text (string)
+error text
 </dd>
-<dt><i>sourcecode</i></dt>
+<dt><i>sourcecode</i> (str)</dt>
 <dd>
-faulty line of code (string)
+faulty line of code
 </dd>
-<dt><i>isWarning</i></dt>
+<dt><i>isWarning</i> (bool)</dt>
 <dd>
-flag indicating a warning message (boolean)
+flag indicating a warning message
 </dd>
 </dl>
 <a NAME="SyntaxCheckerDialog.__finish" ID="SyntaxCheckerDialog.__finish"></a>
@@ -252,16 +256,16 @@
 </p>
 <dl>
 
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-filename of the checked file (str)
+filename of the checked file
 </dd>
-<dt><i>problems</i></dt>
+<dt><i>problems</i> (dict)</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) (dict)
+            errors), the message)
 </dd>
 </dl>
 <a NAME="SyntaxCheckerDialog.__resort" ID="SyntaxCheckerDialog.__resort"></a>
@@ -283,9 +287,9 @@
 </p>
 <dl>
 
-<dt><i>codestring</i></dt>
+<dt><i>codestring</i> (str)</dt>
 <dd>
-optional sourcestring (str)
+optional sourcestring
 </dd>
 </dl>
 <a NAME="SyntaxCheckerDialog.checkBatch" ID="SyntaxCheckerDialog.checkBatch"></a>
@@ -307,9 +311,9 @@
 </p>
 <dl>
 
-<dt><i>button</i></dt>
+<dt><i>button</i> (QAbstractButton)</dt>
 <dd>
-button that was clicked (QAbstractButton)
+button that was clicked
 </dd>
 </dl>
 <a NAME="SyntaxCheckerDialog.on_resultList_itemActivated" ID="SyntaxCheckerDialog.on_resultList_itemActivated"></a>
@@ -321,13 +325,13 @@
 </p>
 <dl>
 
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (QTreeWidgetItem)</dt>
 <dd>
-reference to the activated item (QTreeWidgetItem)
+reference to the activated item
 </dd>
-<dt><i>col</i></dt>
+<dt><i>col</i> (int)</dt>
 <dd>
-column the item was activated in (integer)
+column the item was activated in
 </dd>
 </dl>
 <a NAME="SyntaxCheckerDialog.on_showButton_clicked" ID="SyntaxCheckerDialog.on_showButton_clicked"></a>
@@ -353,13 +357,13 @@
 </p>
 <dl>
 
-<dt><i>fileList</i></dt>
+<dt><i>fileList</i> (list of str)</dt>
 <dd>
-list of filenames (list of strings)
+list of filenames
 </dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
-reference to the project object (Project)
+reference to the project object
 </dd>
 </dl>
 <a NAME="SyntaxCheckerDialog.start" ID="SyntaxCheckerDialog.start"></a>
@@ -371,15 +375,28 @@
 </p>
 <dl>
 
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str or list of str)</dt>
 <dd>
 file or list of files or directory to be checked
-                (string or list of strings)
+</dd>
+<dt><i>codestring</i> (str)</dt>
+<dd>
+string containing the code to be checked. If this is given,
+            fn must be a single file name.
 </dd>
-<dt><i>codestring</i></dt>
+</dl>
+<a NAME="SyntaxCheckerDialog.startForBrowser" ID="SyntaxCheckerDialog.startForBrowser"></a>
+<h4>SyntaxCheckerDialog.startForBrowser</h4>
+<b>startForBrowser</b>(<i>fn</i>)
+
+<p>
+        Public slot to start the syntax check for the project sources browser.
+</p>
+<dl>
+
+<dt><i>fn</i> (str or list of str)</dt>
 <dd>
-string containing the code to be checked (string).
-            If this is given, fn must be a single file name.
+file or list of files or directory to be checked
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>