--- a/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html Thu Jun 04 17:57:20 2020 +0200
+++ b/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html Sat Jun 06 19:42:15 2020 +0200
@@ -57,7 +57,7 @@
<h3>Class Attributes</h3>
<table>
-<tr><td>availableFutures</td></tr><tr><td>checkCategories</td></tr><tr><td>codeRole</td></tr><tr><td>filenameRole</td></tr><tr><td>fixableRole</td></tr><tr><td>hasResults</td></tr><tr><td>ignoredRole</td></tr><tr><td>lineRole</td></tr><tr><td>messageRole</td></tr><tr><td>noFiles</td></tr><tr><td>noResults</td></tr><tr><td>positionRole</td></tr>
+<tr><td>argsRole</td></tr><tr><td>availableFutures</td></tr><tr><td>checkCategories</td></tr><tr><td>codeRole</td></tr><tr><td>filenameRole</td></tr><tr><td>fixableRole</td></tr><tr><td>hasResults</td></tr><tr><td>ignoredRole</td></tr><tr><td>lineRole</td></tr><tr><td>messageRole</td></tr><tr><td>noFiles</td></tr><tr><td>noResults</td></tr><tr><td>positionRole</td></tr>
</table>
<h3>Class Methods</h3>
@@ -93,6 +93,10 @@
<td>Private slot to create a new error item in the result list.</td>
</tr>
<tr>
+<td><a href="#CodeStyleCheckerDialog.__createFileErrorItem">__createFileErrorItem</a></td>
+<td>Private method to create an error entry for a given file.</td>
+</tr>
+<tr>
<td><a href="#CodeStyleCheckerDialog.__createResultItem">__createResultItem</a></td>
<td>Private method to create an entry in the result list.</td>
</tr>
@@ -351,9 +355,27 @@
error message
</dd>
</dl>
+<a NAME="CodeStyleCheckerDialog.__createFileErrorItem" ID="CodeStyleCheckerDialog.__createFileErrorItem"></a>
+<h4>CodeStyleCheckerDialog.__createFileErrorItem</h4>
+<b>__createFileErrorItem</b>(<i>filename, message</i>)
+
+<p>
+ Private method to create an error entry for a given file.
+</p>
+<dl>
+
+<dt><i>filename</i> (str)</dt>
+<dd>
+file name of the file
+</dd>
+<dt><i>message</i> (str)</dt>
+<dd>
+error message text
+</dd>
+</dl>
<a NAME="CodeStyleCheckerDialog.__createResultItem" ID="CodeStyleCheckerDialog.__createResultItem"></a>
<h4>CodeStyleCheckerDialog.__createResultItem</h4>
-<b>__createResultItem</b>(<i>filename, line, pos, message, fixed, autofixing, ignored</i>)
+<b>__createResultItem</b>(<i>filename, result</i>)
<p>
Private method to create an entry in the result list.
@@ -364,30 +386,9 @@
<dd>
file name of the file
</dd>
-<dt><i>line</i> (int or str)</dt>
-<dd>
-line number of issue
-</dd>
-<dt><i>pos</i> (int or str)</dt>
-<dd>
-character position of issue
-</dd>
-<dt><i>message</i> (str)</dt>
+<dt><i>result</i> (dict)</dt>
<dd>
-message text
-</dd>
-<dt><i>fixed</i> (bool)</dt>
-<dd>
-flag indicating a fixed issue
-</dd>
-<dt><i>autofixing</i> (bool)</dt>
-<dd>
-flag indicating, that we are fixing issues
- automatically
-</dd>
-<dt><i>ignored</i> (bool)</dt>
-<dd>
-flag indicating an ignored issue
+dictionary containing check result data
</dd>
</dl>
<dl>
@@ -597,7 +598,7 @@
</dl>
<a NAME="CodeStyleCheckerDialog.__modifyFixedResultItem" ID="CodeStyleCheckerDialog.__modifyFixedResultItem"></a>
<h4>CodeStyleCheckerDialog.__modifyFixedResultItem</h4>
-<b>__modifyFixedResultItem</b>(<i>itm, text, fixed</i>)
+<b>__modifyFixedResultItem</b>(<i>itm, result</i>)
<p>
Private method to modify a result list entry to show its
@@ -609,13 +610,9 @@
<dd>
reference to the item to modify
</dd>
-<dt><i>text</i> (str)</dt>
+<dt><i>result</i> (dict)</dt>
<dd>
-text to be appended
-</dd>
-<dt><i>fixed</i> (bool)</dt>
-<dd>
-flag indicating a fixed issue
+dictionary containing check result data
</dd>
</dl>
<a NAME="CodeStyleCheckerDialog.__modifyOptions" ID="CodeStyleCheckerDialog.__modifyOptions"></a>
@@ -688,10 +685,9 @@
<dd>
number of applied fixes
</dd>
-<dt><i>results</i> (tuplt of tuple of (int, int, str, bool, bool, bool))</dt>
+<dt><i>results</i> (dict)</dt>
<dd>
-tuple for each found violation of style (tuple of
- lineno, position, text, ignored, fixed, autofixing)
+dictionary containing check result data
</dd>
</dl>
<a NAME="CodeStyleCheckerDialog.__resetStatistics" ID="CodeStyleCheckerDialog.__resetStatistics"></a>
