diff -r 2409ad7298d6 -r b6622920a278 VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerDialog.html
--- a/VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerDialog.html Sat Dec 23 16:08:42 2023 +0100
+++ b/VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerDialog.html Mon Apr 22 16:13:31 2024 +0200
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Checker_Vulture.VultureChecker.VultureCheckerDialog</h1>
-
<p>
Module implementing a dialog to show the vulture check results.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#VultureCheckerDialog">VultureCheckerDialog</a></td>
<td>Class implementing a dialog to show the vulture check results.</td>
@@ -29,35 +27,35 @@
<td>Class to hold the name, type, confidence and location of defined code.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="VultureCheckerDialog" ID="VultureCheckerDialog"></a>
<h2>VultureCheckerDialog</h2>
-
<p>
Class implementing a dialog to show the vulture check results.
</p>
+
<h3>Derived from</h3>
QDialog, Ui_VultureCheckerDialog
<h3>Class Attributes</h3>
+<table>
+<tr><td>FilePathRole</td></tr>
+<tr><td>TypeRole</td></tr>
+</table>
-<table>
-<tr><td>FilePathRole</td></tr><tr><td>TypeRole</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#VultureCheckerDialog.__init__">VultureCheckerDialog</a></td>
<td>Constructor</td>
@@ -195,6 +193,10 @@
<td>Private slot to start a code metrics run.</td>
</tr>
<tr>
+<td><a href="#VultureCheckerDialog.on_typeFilterComboBox_currentTextChanged">on_typeFilterComboBox_currentTextChanged</a></td>
+<td>Private slot to handle the selection of a type filter.</td>
+</tr>
+<tr>
<td><a href="#VultureCheckerDialog.prepare">prepare</a></td>
<td>Public method to prepare the dialog with a list of filenames.</td>
</tr>
@@ -211,19 +213,20 @@
<td>Public method to start a vulture check batch job.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="VultureCheckerDialog.__init__" ID="VultureCheckerDialog.__init__"></a>
<h4>VultureCheckerDialog (Constructor)</h4>
<b>VultureCheckerDialog</b>(<i>vultureService, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>vultureService</i> (VulturePlugin)</dt>
@@ -238,24 +241,24 @@
<a NAME="VultureCheckerDialog.__batchFinished" ID="VultureCheckerDialog.__batchFinished"></a>
<h4>VultureCheckerDialog.__batchFinished</h4>
<b>__batchFinished</b>(<i></i>)
-
<p>
Private slot handling the completion of a batch job.
</p>
+
<a NAME="VultureCheckerDialog.__cancel" ID="VultureCheckerDialog.__cancel"></a>
<h4>VultureCheckerDialog.__cancel</h4>
<b>__cancel</b>(<i></i>)
-
<p>
Private method to cancel the current check run.
</p>
+
<a NAME="VultureCheckerDialog.__createErrorItem" ID="VultureCheckerDialog.__createErrorItem"></a>
<h4>VultureCheckerDialog.__createErrorItem</h4>
<b>__createErrorItem</b>(<i>filename, message</i>)
-
<p>
Private slot to create a new error item in the result list.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -270,10 +273,10 @@
<a NAME="VultureCheckerDialog.__createFileItem" ID="VultureCheckerDialog.__createFileItem"></a>
<h4>VultureCheckerDialog.__createFileItem</h4>
<b>__createFileItem</b>(<i>filename</i>)
-
<p>
Private method to create a file item.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -296,10 +299,10 @@
<a NAME="VultureCheckerDialog.__createResultItem" ID="VultureCheckerDialog.__createResultItem"></a>
<h4>VultureCheckerDialog.__createResultItem</h4>
<b>__createResultItem</b>(<i>parent, item</i>)
-
<p>
Private method to create a result item.
</p>
+
<dl>
<dt><i>parent</i> (QTreeWidgetItem)</dt>
@@ -314,17 +317,17 @@
<a NAME="VultureCheckerDialog.__createResultItems" ID="VultureCheckerDialog.__createResultItems"></a>
<h4>VultureCheckerDialog.__createResultItems</h4>
<b>__createResultItems</b>(<i></i>)
-
<p>
Private method to populate the list with the analysis result.
</p>
+
<a NAME="VultureCheckerDialog.__dict2Item" ID="VultureCheckerDialog.__dict2Item"></a>
<h4>VultureCheckerDialog.__dict2Item</h4>
<b>__dict2Item</b>(<i>d</i>)
-
<p>
Private method to convert an item dictionary to a vulture item.
</p>
+
<dl>
<dt><i>d</i> (dict)</dt>
@@ -347,17 +350,17 @@
<a NAME="VultureCheckerDialog.__editWhiteList" ID="VultureCheckerDialog.__editWhiteList"></a>
<h4>VultureCheckerDialog.__editWhiteList</h4>
<b>__editWhiteList</b>(<i></i>)
-
<p>
Private slot to edit the whitelist.
</p>
+
<a NAME="VultureCheckerDialog.__filterUnusedAttributes" ID="VultureCheckerDialog.__filterUnusedAttributes"></a>
<h4>VultureCheckerDialog.__filterUnusedAttributes</h4>
<b>__filterUnusedAttributes</b>(<i></i>)
-
<p>
Private method to get the list of unused attributes.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -373,10 +376,10 @@
<a NAME="VultureCheckerDialog.__filterUnusedClasses" ID="VultureCheckerDialog.__filterUnusedClasses"></a>
<h4>VultureCheckerDialog.__filterUnusedClasses</h4>
<b>__filterUnusedClasses</b>(<i></i>)
-
<p>
Private method to get the list of unused classes.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -392,10 +395,10 @@
<a NAME="VultureCheckerDialog.__filterUnusedFunctions" ID="VultureCheckerDialog.__filterUnusedFunctions"></a>
<h4>VultureCheckerDialog.__filterUnusedFunctions</h4>
<b>__filterUnusedFunctions</b>(<i></i>)
-
<p>
Private method to get the list of unused functions.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -411,10 +414,10 @@
<a NAME="VultureCheckerDialog.__filterUnusedImports" ID="VultureCheckerDialog.__filterUnusedImports"></a>
<h4>VultureCheckerDialog.__filterUnusedImports</h4>
<b>__filterUnusedImports</b>(<i></i>)
-
<p>
Private method to get a list of unused imports.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -430,10 +433,10 @@
<a NAME="VultureCheckerDialog.__filterUnusedItems" ID="VultureCheckerDialog.__filterUnusedItems"></a>
<h4>VultureCheckerDialog.__filterUnusedItems</h4>
<b>__filterUnusedItems</b>(<i>unused, whitelistName</i>)
-
<p>
Private method to get a list of unused items.
</p>
+
<dl>
<dt><i>unused</i> (list of VultureItem)</dt>
@@ -460,10 +463,10 @@
<a NAME="VultureCheckerDialog.__filterUnusedMethods" ID="VultureCheckerDialog.__filterUnusedMethods"></a>
<h4>VultureCheckerDialog.__filterUnusedMethods</h4>
<b>__filterUnusedMethods</b>(<i></i>)
-
<p>
Private method to get the list of unused methods.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -479,10 +482,10 @@
<a NAME="VultureCheckerDialog.__filterUnusedProperties" ID="VultureCheckerDialog.__filterUnusedProperties"></a>
<h4>VultureCheckerDialog.__filterUnusedProperties</h4>
<b>__filterUnusedProperties</b>(<i></i>)
-
<p>
Private method to get the list of unused properties.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -498,10 +501,10 @@
<a NAME="VultureCheckerDialog.__filterUnusedVariables" ID="VultureCheckerDialog.__filterUnusedVariables"></a>
<h4>VultureCheckerDialog.__filterUnusedVariables</h4>
<b>__filterUnusedVariables</b>(<i></i>)
-
<p>
Private method to get the list of unused variables.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -517,11 +520,11 @@
<a NAME="VultureCheckerDialog.__filteredList" ID="VultureCheckerDialog.__filteredList"></a>
<h4>VultureCheckerDialog.__filteredList</h4>
<b>__filteredList</b>(<i>itemList</i>)
-
<p>
Private method to filter a list against the whitelist patterns
returning items not matching the whitelist.
</p>
+
<dl>
<dt><i>itemList</i> (list of VultureItem)</dt>
@@ -544,18 +547,18 @@
<a NAME="VultureCheckerDialog.__finish" ID="VultureCheckerDialog.__finish"></a>
<h4>VultureCheckerDialog.__finish</h4>
<b>__finish</b>(<i></i>)
-
<p>
Private slot called when the action finished or the user pressed the
cancel button.
</p>
+
<a NAME="VultureCheckerDialog.__getSelectedNonFileItems" ID="VultureCheckerDialog.__getSelectedNonFileItems"></a>
<h4>VultureCheckerDialog.__getSelectedNonFileItems</h4>
<b>__getSelectedNonFileItems</b>(<i></i>)
-
<p>
Private method to get a list of selected non file items.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -571,17 +574,17 @@
<a NAME="VultureCheckerDialog.__prepareResultLists" ID="VultureCheckerDialog.__prepareResultLists"></a>
<h4>VultureCheckerDialog.__prepareResultLists</h4>
<b>__prepareResultLists</b>(<i></i>)
-
<p>
Private method to prepare the result lists.
</p>
+
<a NAME="VultureCheckerDialog.__processError" ID="VultureCheckerDialog.__processError"></a>
<h4>VultureCheckerDialog.__processError</h4>
<b>__processError</b>(<i>fn, msg</i>)
-
<p>
Private slot to process an error indication from the service.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -596,10 +599,10 @@
<a NAME="VultureCheckerDialog.__processResult" ID="VultureCheckerDialog.__processResult"></a>
<h4>VultureCheckerDialog.__processResult</h4>
<b>__processResult</b>(<i>fn, result</i>)
-
<p>
Private slot called after performing a vulture analysis on one file.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -614,24 +617,24 @@
<a NAME="VultureCheckerDialog.__resultCollapse" ID="VultureCheckerDialog.__resultCollapse"></a>
<h4>VultureCheckerDialog.__resultCollapse</h4>
<b>__resultCollapse</b>(<i></i>)
-
<p>
Private slot to collapse all entries of the resultlist.
</p>
+
<a NAME="VultureCheckerDialog.__resultExpand" ID="VultureCheckerDialog.__resultExpand"></a>
<h4>VultureCheckerDialog.__resultExpand</h4>
<b>__resultExpand</b>(<i></i>)
-
<p>
Private slot to expand all entries of the resultlist.
</p>
+
<a NAME="VultureCheckerDialog.__showContextMenu" ID="VultureCheckerDialog.__showContextMenu"></a>
<h4>VultureCheckerDialog.__showContextMenu</h4>
<b>__showContextMenu</b>(<i>coord</i>)
-
<p>
Private slot to show the context menu of the listview.
</p>
+
<dl>
<dt><i>coord</i> (QPoint)</dt>
@@ -642,10 +645,10 @@
<a NAME="VultureCheckerDialog.__storeResult" ID="VultureCheckerDialog.__storeResult"></a>
<h4>VultureCheckerDialog.__storeResult</h4>
<b>__storeResult</b>(<i>result</i>)
-
<p>
Private method to store the result of an analysis.
</p>
+
<dl>
<dt><i>result</i> (dict)</dt>
@@ -656,10 +659,10 @@
<a NAME="VultureCheckerDialog.__storeWhiteLists" ID="VultureCheckerDialog.__storeWhiteLists"></a>
<h4>VultureCheckerDialog.__storeWhiteLists</h4>
<b>__storeWhiteLists</b>(<i>whitelists</i>)
-
<p>
Private method to store the new whitelists, if they have changed.
</p>
+
<dl>
<dt><i>whitelists</i> (dict of list of str)</dt>
@@ -670,24 +673,24 @@
<a NAME="VultureCheckerDialog.__whiteList" ID="VultureCheckerDialog.__whiteList"></a>
<h4>VultureCheckerDialog.__whiteList</h4>
<b>__whiteList</b>(<i></i>)
-
<p>
Private slot to add entries to the whitelist.
</p>
+
<a NAME="VultureCheckerDialog.clear" ID="VultureCheckerDialog.clear"></a>
<h4>VultureCheckerDialog.clear</h4>
<b>clear</b>(<i></i>)
-
<p>
Public method to clear all results.
</p>
+
<a NAME="VultureCheckerDialog.closeEvent" ID="VultureCheckerDialog.closeEvent"></a>
<h4>VultureCheckerDialog.closeEvent</h4>
<b>closeEvent</b>(<i>evt</i>)
-
<p>
Protected method to handle a close event.
</p>
+
<dl>
<dt><i>evt</i> (QCloseEvent)</dt>
@@ -698,10 +701,10 @@
<a NAME="VultureCheckerDialog.on_buttonBox_clicked" ID="VultureCheckerDialog.on_buttonBox_clicked"></a>
<h4>VultureCheckerDialog.on_buttonBox_clicked</h4>
<b>on_buttonBox_clicked</b>(<i>button</i>)
-
<p>
Private slot called by a button of the button box clicked.
</p>
+
<dl>
<dt><i>button</i> (QAbstractButton)</dt>
@@ -712,10 +715,10 @@
<a NAME="VultureCheckerDialog.on_resultList_itemActivated" ID="VultureCheckerDialog.on_resultList_itemActivated"></a>
<h4>VultureCheckerDialog.on_resultList_itemActivated</h4>
<b>on_resultList_itemActivated</b>(<i>item, column</i>)
-
<p>
Private slot to handle the activation of a result item.
</p>
+
<dl>
<dt><i>item</i> (QTreeWidgetItem)</dt>
@@ -730,17 +733,31 @@
<a NAME="VultureCheckerDialog.on_startButton_clicked" ID="VultureCheckerDialog.on_startButton_clicked"></a>
<h4>VultureCheckerDialog.on_startButton_clicked</h4>
<b>on_startButton_clicked</b>(<i></i>)
-
<p>
Private slot to start a code metrics run.
</p>
+
+<a NAME="VultureCheckerDialog.on_typeFilterComboBox_currentTextChanged" ID="VultureCheckerDialog.on_typeFilterComboBox_currentTextChanged"></a>
+<h4>VultureCheckerDialog.on_typeFilterComboBox_currentTextChanged</h4>
+<b>on_typeFilterComboBox_currentTextChanged</b>(<i>typeFilter</i>)
+<p>
+ Private slot to handle the selection of a type filter.
+</p>
+
+<dl>
+
+<dt><i>typeFilter</i> (str)</dt>
+<dd>
+type of the selected filter entry
+</dd>
+</dl>
<a NAME="VultureCheckerDialog.prepare" ID="VultureCheckerDialog.prepare"></a>
<h4>VultureCheckerDialog.prepare</h4>
<b>prepare</b>(<i>fileList, project</i>)
-
<p>
Public method to prepare the dialog with a list of filenames.
</p>
+
<dl>
<dt><i>fileList</i> (list of str)</dt>
@@ -755,10 +772,10 @@
<a NAME="VultureCheckerDialog.start" ID="VultureCheckerDialog.start"></a>
<h4>VultureCheckerDialog.start</h4>
<b>start</b>(<i>fn</i>)
-
<p>
Public slot to start the code metrics determination.
</p>
+
<dl>
<dt><i>fn</i> (str or list of str)</dt>
@@ -770,66 +787,65 @@
<a NAME="VultureCheckerDialog.vultureCheck" ID="VultureCheckerDialog.vultureCheck"></a>
<h4>VultureCheckerDialog.vultureCheck</h4>
<b>vultureCheck</b>(<i></i>)
-
<p>
Public method to start a vulture check for one Python file.
</p>
<p>
The results are reported to the __processResult slot.
</p>
+
<a NAME="VultureCheckerDialog.vultureCheckBatch" ID="VultureCheckerDialog.vultureCheckBatch"></a>
<h4>VultureCheckerDialog.vultureCheckBatch</h4>
<b>vultureCheckBatch</b>(<i></i>)
-
<p>
Public method to start a vulture check batch job.
</p>
<p>
The results are reported to the __processResult slot.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="VultureItem" ID="VultureItem"></a>
<h2>VultureItem</h2>
-
<p>
Class to hold the name, type, confidence and location of defined code.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#VultureItem.__init__">VultureItem</a></td>
<td>Constructor</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="VultureItem.__init__" ID="VultureItem.__init__"></a>
<h4>VultureItem (Constructor)</h4>
<b>VultureItem</b>(<i>name, typ, filename, firstLineno, lastLineno, confidence</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -859,4 +875,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
