VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerDialog.html

changeset 69
3c2922b45a9f
parent 62
4a69da851bd2
child 83
7a6fb6e896e0
--- a/VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerDialog.html	Wed Dec 30 11:02:01 2020 +0100
+++ b/VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerDialog.html	Sun Apr 25 16:13:53 2021 +0200
@@ -105,6 +105,38 @@
 <td>Private slot to edit the whitelist.</td>
 </tr>
 <tr>
+<td><a href="#VultureCheckerDialog.__filterUnusedAttributes">__filterUnusedAttributes</a></td>
+<td>Private method to get the list of unused attributes.</td>
+</tr>
+<tr>
+<td><a href="#VultureCheckerDialog.__filterUnusedClasses">__filterUnusedClasses</a></td>
+<td>Private method to get the list of unused classes.</td>
+</tr>
+<tr>
+<td><a href="#VultureCheckerDialog.__filterUnusedFunctions">__filterUnusedFunctions</a></td>
+<td>Private method to get the list of unused functions.</td>
+</tr>
+<tr>
+<td><a href="#VultureCheckerDialog.__filterUnusedImports">__filterUnusedImports</a></td>
+<td>Private method to get a list of unused imports.</td>
+</tr>
+<tr>
+<td><a href="#VultureCheckerDialog.__filterUnusedItems">__filterUnusedItems</a></td>
+<td>Private method to get a list of unused items.</td>
+</tr>
+<tr>
+<td><a href="#VultureCheckerDialog.__filterUnusedMethods">__filterUnusedMethods</a></td>
+<td>Private method to get the list of unused methods.</td>
+</tr>
+<tr>
+<td><a href="#VultureCheckerDialog.__filterUnusedProperties">__filterUnusedProperties</a></td>
+<td>Private method to get the list of unused properties.</td>
+</tr>
+<tr>
+<td><a href="#VultureCheckerDialog.__filterUnusedVariables">__filterUnusedVariables</a></td>
+<td>Private method to get the list of unused variables.</td>
+</tr>
+<tr>
 <td><a href="#VultureCheckerDialog.__filteredList">__filteredList</a></td>
 <td>Private method to filter a list against the whitelist patterns returning items not matching the whitelist.</td>
 </tr>
@@ -117,10 +149,6 @@
 <td>Private method to get a list of selected non file items.</td>
 </tr>
 <tr>
-<td><a href="#VultureCheckerDialog.__getUnusedItems">__getUnusedItems</a></td>
-<td>Private method to get a list of unused items.</td>
-</tr>
-<tr>
 <td><a href="#VultureCheckerDialog.__prepareResultLists">__prepareResultLists</a></td>
 <td>Private method to prepare the result lists.</td>
 </tr>
@@ -153,34 +181,6 @@
 <td>Private method to store the new whitelists, if they have changed.</td>
 </tr>
 <tr>
-<td><a href="#VultureCheckerDialog.__unusedAttributes">__unusedAttributes</a></td>
-<td>Private method to get the list of unused attributes.</td>
-</tr>
-<tr>
-<td><a href="#VultureCheckerDialog.__unusedClasses">__unusedClasses</a></td>
-<td>Private method to get the list of unused classes.</td>
-</tr>
-<tr>
-<td><a href="#VultureCheckerDialog.__unusedFunctions">__unusedFunctions</a></td>
-<td>Private method to get the list of unused functions.</td>
-</tr>
-<tr>
-<td><a href="#VultureCheckerDialog.__unusedImports">__unusedImports</a></td>
-<td>Private method to get a list of unused imports.</td>
-</tr>
-<tr>
-<td><a href="#VultureCheckerDialog.__unusedProperties">__unusedProperties</a></td>
-<td>Private method to get the list of unused properties.</td>
-</tr>
-<tr>
-<td><a href="#VultureCheckerDialog.__unusedSlots">__unusedSlots</a></td>
-<td>Private method to get the list of unused PyQt/PySide slots.</td>
-</tr>
-<tr>
-<td><a href="#VultureCheckerDialog.__unusedVariables">__unusedVariables</a></td>
-<td>Private method to get the list of unused variables.</td>
-</tr>
-<tr>
 <td><a href="#VultureCheckerDialog.__whiteList">__whiteList</a></td>
 <td>Private slot to add entries to the whitelist.</td>
 </tr>
@@ -281,7 +281,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 reference to the created item
 </dd>
@@ -332,7 +332,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 vulture item
 </dd>
@@ -350,6 +350,169 @@
 <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>
+list of unused attributes
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of VultureItem
+</dd>
+</dl>
+<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>
+list of unused classes
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of VultureItem
+</dd>
+</dl>
+<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>
+list of unused functions
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of VultureItem
+</dd>
+</dl>
+<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>
+list of unused imports
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of VultureItem
+</dd>
+</dl>
+<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>
+<dd>
+list of unused items
+</dd>
+<dt><i>whitelistName</i> (str)</dt>
+<dd>
+name of the whitelist to use as a filter
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of unused items
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of VultureItem
+</dd>
+</dl>
+<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>
+list of unused methods
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of VultureItem
+</dd>
+</dl>
+<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>
+list of unused properties
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of VultureItem
+</dd>
+</dl>
+<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>
+list of unused variables
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of VultureItem
+</dd>
+</dl>
 <a NAME="VultureCheckerDialog.__filteredList" ID="VultureCheckerDialog.__filteredList"></a>
 <h4>VultureCheckerDialog.__filteredList</h4>
 <b>__filteredList</b>(<i>itemList</i>)
@@ -366,7 +529,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of filtered items
 </dd>
@@ -393,7 +556,7 @@
         Private method to get a list of selected non file items.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of selected non file items
 </dd>
@@ -404,36 +567,6 @@
 list of QTreeWidgetItem
 </dd>
 </dl>
-<a NAME="VultureCheckerDialog.__getUnusedItems" ID="VultureCheckerDialog.__getUnusedItems"></a>
-<h4>VultureCheckerDialog.__getUnusedItems</h4>
-<b>__getUnusedItems</b>(<i>defined, used</i>)
-
-<p>
-        Private method to get a list of unused items.
-</p>
-<dl>
-
-<dt><i>defined</i> (list of VultureItem)</dt>
-<dd>
-list of defined items
-</dd>
-<dt><i>used</i> (list of str)</dt>
-<dd>
-list of used names
-</dd>
-</dl>
-<dl>
-<dt>Returns:</dt>
-<dd>
-list of unused items
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-list of VultureItem
-</dd>
-</dl>
 <a NAME="VultureCheckerDialog.__prepareResultLists" ID="VultureCheckerDialog.__prepareResultLists"></a>
 <h4>VultureCheckerDialog.__prepareResultLists</h4>
 <b>__prepareResultLists</b>(<i></i>)
@@ -533,139 +666,6 @@
 dictionary of lists of whitelisted names
 </dd>
 </dl>
-<a NAME="VultureCheckerDialog.__unusedAttributes" ID="VultureCheckerDialog.__unusedAttributes"></a>
-<h4>VultureCheckerDialog.__unusedAttributes</h4>
-<b>__unusedAttributes</b>(<i></i>)
-
-<p>
-        Private method to get the list of unused attributes.
-</p>
-<dl>
-<dt>Returns:</dt>
-<dd>
-list of unused attributes
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-list of VultureItem
-</dd>
-</dl>
-<a NAME="VultureCheckerDialog.__unusedClasses" ID="VultureCheckerDialog.__unusedClasses"></a>
-<h4>VultureCheckerDialog.__unusedClasses</h4>
-<b>__unusedClasses</b>(<i></i>)
-
-<p>
-        Private method to get the list of unused classes.
-</p>
-<dl>
-<dt>Returns:</dt>
-<dd>
-list of unused classes
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-list of VultureItem
-</dd>
-</dl>
-<a NAME="VultureCheckerDialog.__unusedFunctions" ID="VultureCheckerDialog.__unusedFunctions"></a>
-<h4>VultureCheckerDialog.__unusedFunctions</h4>
-<b>__unusedFunctions</b>(<i></i>)
-
-<p>
-        Private method to get the list of unused functions.
-</p>
-<dl>
-<dt>Returns:</dt>
-<dd>
-list of unused functions
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-list of VultureItem
-</dd>
-</dl>
-<a NAME="VultureCheckerDialog.__unusedImports" ID="VultureCheckerDialog.__unusedImports"></a>
-<h4>VultureCheckerDialog.__unusedImports</h4>
-<b>__unusedImports</b>(<i></i>)
-
-<p>
-        Private method to get a list of unused imports.
-</p>
-<dl>
-<dt>Returns:</dt>
-<dd>
-list of unused imports
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-list of VultureItem
-</dd>
-</dl>
-<a NAME="VultureCheckerDialog.__unusedProperties" ID="VultureCheckerDialog.__unusedProperties"></a>
-<h4>VultureCheckerDialog.__unusedProperties</h4>
-<b>__unusedProperties</b>(<i></i>)
-
-<p>
-        Private method to get the list of unused properties.
-</p>
-<dl>
-<dt>Returns:</dt>
-<dd>
-list of unused properties
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-list of VultureItem
-</dd>
-</dl>
-<a NAME="VultureCheckerDialog.__unusedSlots" ID="VultureCheckerDialog.__unusedSlots"></a>
-<h4>VultureCheckerDialog.__unusedSlots</h4>
-<b>__unusedSlots</b>(<i></i>)
-
-<p>
-        Private method to get the list of unused PyQt/PySide slots.
-</p>
-<dl>
-<dt>Returns:</dt>
-<dd>
-list of unused PyQt/PySide slots
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-list of VultureItem
-</dd>
-</dl>
-<a NAME="VultureCheckerDialog.__unusedVariables" ID="VultureCheckerDialog.__unusedVariables"></a>
-<h4>VultureCheckerDialog.__unusedVariables</h4>
-<b>__unusedVariables</b>(<i></i>)
-
-<p>
-        Private method to get the list of unused variables.
-</p>
-<dl>
-<dt>Returns:</dt>
-<dd>
-list of unused variables
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-list of VultureItem
-</dd>
-</dl>
 <a NAME="VultureCheckerDialog.__whiteList" ID="VultureCheckerDialog.__whiteList"></a>
 <h4>VultureCheckerDialog.__whiteList</h4>
 <b>__whiteList</b>(<i></i>)
@@ -782,7 +782,7 @@
     Class to hold the name, type, confidence and location of defined code.
 </p>
 <h3>Derived from</h3>
-object
+None
 <h3>Class Attributes</h3>
 
 <table>

eric ide

mercurial