eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html

changeset 7986
2971d5d19951
parent 7632
7ac16bf7695b
child 7989
a21d673a8f99
--- a/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html	Fri Jan 15 19:46:04 2021 +0100
+++ b/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html	Fri Jan 15 19:49:36 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>
@@ -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>Returns:</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>)
@@ -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>)
@@ -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>)

eric ide

mercurial