diff -r 866adc8c315b -r 0acf98cd089a eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html
--- a/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html Sun Jan 17 13:53:08 2021 +0100
+++ b/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html Mon Feb 01 10:38:16 2021 +0100
@@ -113,6 +113,10 @@
<td>Private method to get the enabled or disabled checker categories.</td>
</tr>
<tr>
+<td><a href="#CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList">__getCommentedCodeCheckerWhiteList</a></td>
+<td>Private method to get the list of commented code whitelist patterns.</td>
+</tr>
+<tr>
<td><a href="#CodeStyleCheckerDialog.__getEol">__getEol</a></td>
<td>Private method to get the applicable eol string.</td>
</tr>
@@ -133,6 +137,10 @@
<td>Private method to set the enabled status of the checker categories.</td>
</tr>
<tr>
+<td><a href="#CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList">__initCommentedCodeCheckerWhiteList</a></td>
+<td>Private method to populate the list of commented code whitelist patterns.</td>
+</tr>
+<tr>
<td><a href="#CodeStyleCheckerDialog.__initFuturesList">__initFuturesList</a></td>
<td>Private method to set the selected status of the future imports.</td>
</tr>
@@ -197,6 +205,10 @@
<td>Private slot to add a built-in assignment to be ignored.</td>
</tr>
<tr>
+<td><a href="#CodeStyleCheckerDialog.on_addWhitelistButton_clicked">on_addWhitelistButton_clicked</a></td>
+<td>Private slot to add a commented code whitelist pattern.</td>
+</tr>
+<tr>
<td><a href="#CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged">on_builtinsAssignmentList_itemSelectionChanged</a></td>
<td>Private slot to react upon changes of the selected builtin assignments.</td>
</tr>
@@ -213,6 +225,10 @@
<td>Private slot to delete the selected items from the list.</td>
</tr>
<tr>
+<td><a href="#CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked">on_deleteWhitelistButton_clicked</a></td>
+<td>Private slot to delete the selected items from the list.</td>
+</tr>
+<tr>
<td><a href="#CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked">on_excludeMessagesSelectButton_clicked</a></td>
<td>Private slot to select the message codes to be excluded via a selection dialog.</td>
</tr>
@@ -269,6 +285,10 @@
<td>Private slot to store the current configuration values as default values.</td>
</tr>
<tr>
+<td><a href="#CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged">on_whitelistWidget_itemSelectionChanged</a></td>
+<td>Private slot to react upon changes of the selected whitelist patterns.</td>
+</tr>
+<tr>
<td><a href="#CodeStyleCheckerDialog.prepare">prepare</a></td>
<td>Public method to prepare the dialog with a list of filenames.</td>
</tr>
@@ -314,7 +334,7 @@
Private method to assemble the list of excluded checks.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of excluded checks as a comma separated string.
</dd>
@@ -409,7 +429,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the created item
</dd>
@@ -437,7 +457,7 @@
to be ignored.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
dictionary containing the builtins assignments to be ignored
</dd>
@@ -468,7 +488,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
checker categories as a list or comma separated string
</dd>
@@ -479,6 +499,25 @@
str or list of str
</dd>
</dl>
+<a NAME="CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList" ID="CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList"></a>
+<h4>CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList</h4>
+<b>__getCommentedCodeCheckerWhiteList</b>(<i></i>)
+
+<p>
+ Private method to get the list of commented code whitelist patterns.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of commented code whitelist patterns
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
<a NAME="CodeStyleCheckerDialog.__getEol" ID="CodeStyleCheckerDialog.__getEol"></a>
<h4>CodeStyleCheckerDialog.__getEol</h4>
<b>__getEol</b>(<i>fn</i>)
@@ -494,7 +533,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
eol string
</dd>
@@ -513,7 +552,7 @@
Private method to extract all selected items for fixable issues.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
selected items for fixable issues
</dd>
@@ -532,7 +571,7 @@
Private method to get the expected future imports.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
expected future imports as a comma separated string
</dd>
@@ -573,6 +612,21 @@
categories
</dd>
</dl>
+<a NAME="CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList" ID="CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList"></a>
+<h4>CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList</h4>
+<b>__initCommentedCodeCheckerWhiteList</b>(<i>whitelist</i>)
+
+<p>
+ Private method to populate the list of commented code whitelist
+ patterns.
+</p>
+<dl>
+
+<dt><i>whitelist</i> (list of str)</dt>
+<dd>
+list of commented code whitelist patterns
+</dd>
+</dl>
<a NAME="CodeStyleCheckerDialog.__initFuturesList" ID="CodeStyleCheckerDialog.__initFuturesList"></a>
<h4>CodeStyleCheckerDialog.__initFuturesList</h4>
<b>__initFuturesList</b>(<i>selectedFutures</i>)
@@ -602,7 +656,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating a fixable issue
</dd>
@@ -652,7 +706,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of checker options
</dd>
@@ -840,6 +894,13 @@
<p>
Private slot to add a built-in assignment to be ignored.
</p>
+<a NAME="CodeStyleCheckerDialog.on_addWhitelistButton_clicked" ID="CodeStyleCheckerDialog.on_addWhitelistButton_clicked"></a>
+<h4>CodeStyleCheckerDialog.on_addWhitelistButton_clicked</h4>
+<b>on_addWhitelistButton_clicked</b>(<i></i>)
+
+<p>
+ Private slot to add a commented code whitelist pattern.
+</p>
<a NAME="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged"></a>
<h4>CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged</h4>
<b>on_builtinsAssignmentList_itemSelectionChanged</b>(<i></i>)
@@ -875,6 +936,13 @@
<p>
Private slot to delete the selected items from the list.
</p>
+<a NAME="CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked" ID="CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked"></a>
+<h4>CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked</h4>
+<b>on_deleteWhitelistButton_clicked</b>(<i></i>)
+
+<p>
+ Private slot to delete the selected items from the list.
+</p>
<a NAME="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked"></a>
<h4>CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked</h4>
<b>on_excludeMessagesSelectButton_clicked</b>(<i></i>)
@@ -993,6 +1061,13 @@
Private slot to store the current configuration values as
default values.
</p>
+<a NAME="CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged"></a>
+<h4>CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged</h4>
+<b>on_whitelistWidget_itemSelectionChanged</b>(<i></i>)
+
+<p>
+ Private slot to react upon changes of the selected whitelist patterns.
+</p>
<a NAME="CodeStyleCheckerDialog.prepare" ID="CodeStyleCheckerDialog.prepare"></a>
<h4>CodeStyleCheckerDialog.prepare</h4>
<b>prepare</b>(<i>fileList, project</i>)
