--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog.html Sat Nov 11 12:44:51 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog.html Sat Nov 11 16:21:15 2023 +0100
@@ -75,10 +75,22 @@
<td>Private slot to create a new error item in the result list.</td>
</tr>
<tr>
+<td><a href="#SyntaxCheckerDialog.__createFileStatistics">__createFileStatistics</a></td>
+<td>Private method to return the file statistics entry.</td>
+</tr>
+<tr>
+<td><a href="#SyntaxCheckerDialog.__createHeaderItem">__createHeaderItem</a></td>
+<td>Private method to create a header item in the result list.</td>
+</tr>
+<tr>
<td><a href="#SyntaxCheckerDialog.__createResultItem">__createResultItem</a></td>
<td>Private method to create an entry in the result list.</td>
</tr>
<tr>
+<td><a href="#SyntaxCheckerDialog.__defaultStatistics">__defaultStatistics</a></td>
+<td>Private method to return the default statistics entry.</td>
+</tr>
+<tr>
<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>
@@ -91,10 +103,22 @@
<td>Private slot to display the reported messages.</td>
</tr>
<tr>
+<td><a href="#SyntaxCheckerDialog.__resetStatistics">__resetStatistics</a></td>
+<td>Private method to reset the statistics data.</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.__updateStatistics">__updateStatistics</a></td>
+<td>Private method to update the statistics.</td>
+</tr>
+<tr>
+<td><a href="#SyntaxCheckerDialog.__updateStatisticsArea">__updateStatisticsArea</a></td>
+<td>Private method to update the statistics area of the dialog.</td>
+</tr>
+<tr>
<td><a href="#SyntaxCheckerDialog.check">check</a></td>
<td>Public method to start a check for one file.</td>
</tr>
@@ -206,6 +230,52 @@
error message
</dd>
</dl>
+<a NAME="SyntaxCheckerDialog.__createFileStatistics" ID="SyntaxCheckerDialog.__createFileStatistics"></a>
+<h4>SyntaxCheckerDialog.__createFileStatistics</h4>
+<b>__createFileStatistics</b>(<i>problems</i>)
+
+<p>
+ Private method to return the file statistics entry.
+</p>
+<dl>
+
+<dt><i>problems</i> (dict)</dt>
+<dd>
+dictionary with the keys 'error', 'py_warnings' and
+ 'warnings' which hold a list of issues each
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary with the file statistics
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<a NAME="SyntaxCheckerDialog.__createHeaderItem" ID="SyntaxCheckerDialog.__createHeaderItem"></a>
+<h4>SyntaxCheckerDialog.__createHeaderItem</h4>
+<b>__createHeaderItem</b>(<i>filename, fileStatistics=None</i>)
+
+<p>
+ Private method to create a header item in the result list.
+</p>
+<dl>
+
+<dt><i>filename</i> (str)</dt>
+<dd>
+file name of file
+</dd>
+<dt><i>fileStatistics</i> (dict (optional))</dt>
+<dd>
+dictionary containing statistical data of the check
+ result (defaults to None)
+</dd>
+</dl>
<a NAME="SyntaxCheckerDialog.__createResultItem" ID="SyntaxCheckerDialog.__createResultItem"></a>
<h4>SyntaxCheckerDialog.__createResultItem</h4>
<b>__createResultItem</b>(<i>filename, line, index, error, sourcecode, isWarning=False</i>)
@@ -240,6 +310,25 @@
flag indicating a warning message
</dd>
</dl>
+<a NAME="SyntaxCheckerDialog.__defaultStatistics" ID="SyntaxCheckerDialog.__defaultStatistics"></a>
+<h4>SyntaxCheckerDialog.__defaultStatistics</h4>
+<b>__defaultStatistics</b>(<i></i>)
+
+<p>
+ Private method to return the default statistics entry.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary with default statistics entry
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
<a NAME="SyntaxCheckerDialog.__finish" ID="SyntaxCheckerDialog.__finish"></a>
<h4>SyntaxCheckerDialog.__finish</h4>
<b>__finish</b>(<i></i>)
@@ -281,10 +370,24 @@
</dd>
<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)
+dictionary with the keys 'error', 'py_warnings' and
+ 'warnings' which hold a list containing details about the error or
+ warnings (file name, line number, column, codestring (only at syntax
+ errors), message)
+</dd>
+</dl>
+<a NAME="SyntaxCheckerDialog.__resetStatistics" ID="SyntaxCheckerDialog.__resetStatistics"></a>
+<h4>SyntaxCheckerDialog.__resetStatistics</h4>
+<b>__resetStatistics</b>(<i>skipped</i>)
+
+<p>
+ Private method to reset the statistics data.
+</p>
+<dl>
+
+<dt><i>skipped</i> (int)</dt>
+<dd>
+number of files not being checked
</dd>
</dl>
<a NAME="SyntaxCheckerDialog.__resort" ID="SyntaxCheckerDialog.__resort"></a>
@@ -294,6 +397,27 @@
<p>
Private method to resort the tree.
</p>
+<a NAME="SyntaxCheckerDialog.__updateStatistics" ID="SyntaxCheckerDialog.__updateStatistics"></a>
+<h4>SyntaxCheckerDialog.__updateStatistics</h4>
+<b>__updateStatistics</b>(<i>fileStatistics</i>)
+
+<p>
+ Private method to update the statistics.
+</p>
+<dl>
+
+<dt><i>fileStatistics</i> (dict)</dt>
+<dd>
+dictionary containing the file statistics
+</dd>
+</dl>
+<a NAME="SyntaxCheckerDialog.__updateStatisticsArea" ID="SyntaxCheckerDialog.__updateStatisticsArea"></a>
+<h4>SyntaxCheckerDialog.__updateStatisticsArea</h4>
+<b>__updateStatisticsArea</b>(<i></i>)
+
+<p>
+ Private method to update the statistics area of the dialog.
+</p>
<a NAME="SyntaxCheckerDialog.check" ID="SyntaxCheckerDialog.check"></a>
<h4>SyntaxCheckerDialog.check</h4>
<b>check</b>(<i>codestring=""</i>)
@@ -415,7 +539,7 @@
</dl>
<a NAME="SyntaxCheckerDialog.start" ID="SyntaxCheckerDialog.start"></a>
<h4>SyntaxCheckerDialog.start</h4>
-<b>start</b>(<i>fn, codestring=""</i>)
+<b>start</b>(<i>fn, codestring="", skipped=0</i>)
<p>
Public slot to start the syntax check.
@@ -431,6 +555,10 @@
string containing the code to be checked. If this is given,
fn must be a single file name.
</dd>
+<dt><i>skipped</i> (int)</dt>
+<dd>
+number of files not being checked
+</dd>
</dl>
<a NAME="SyntaxCheckerDialog.startForBrowser" ID="SyntaxCheckerDialog.startForBrowser"></a>
<h4>SyntaxCheckerDialog.startForBrowser</h4>
