--- a/VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerService.html Sat Dec 23 16:08:42 2023 +0100 +++ b/VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerService.html Mon Apr 22 16:13:31 2024 +0200 @@ -7,28 +7,25 @@ <body> <a NAME="top" ID="top"></a> <h1>Plugin_Checker_Vulture.VultureChecker.VultureCheckerService</h1> - <p> Module implementing the cyclomatic complexity service. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#EricVulture">EricVulture</a></td> <td>Class to adopt the Vulture class to the eric plug-in functionality.</td> </tr> </table> + <h3>Functions</h3> - <table> - <tr> <td><a href="#__analyze">__analyze</a></td> <td>Private function to analyze one Python file.</td> @@ -54,30 +51,29 @@ <td>Module function acting as the parallel worker for the vulture check.</td> </tr> </table> + <hr /> <hr /> <a NAME="EricVulture" ID="EricVulture"></a> <h2>EricVulture</h2> - <p> Class to adopt the Vulture class to the eric plug-in functionality. </p> + <h3>Derived from</h3> Vulture <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="#EricVulture.__item2Dict">__item2Dict</a></td> <td>Private method to convert a vulture item to a dictionary.</td> @@ -87,19 +83,20 @@ <td>Public method to get the scan results.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="EricVulture.__item2Dict" ID="EricVulture.__item2Dict"></a> <h4>EricVulture.__item2Dict</h4> <b>__item2Dict</b>(<i>item</i>) - <p> Private method to convert a vulture item to a dictionary. </p> + <dl> <dt><i>item</i> (vulture.Item)</dt> @@ -122,10 +119,10 @@ <a NAME="EricVulture.getResults" ID="EricVulture.getResults"></a> <h4>EricVulture.getResults</h4> <b>getResults</b>(<i></i>) - <p> Public method to get the scan results. </p> + <dl> <dt>Return:</dt> <dd> @@ -144,10 +141,10 @@ <a NAME="__analyze" ID="__analyze"></a> <h2>__analyze</h2> <b>__analyze</b>(<i>filename, text=""</i>) - <p> Private function to analyze one Python file. </p> + <dl> <dt><i>filename</i> (str)</dt> @@ -177,10 +174,10 @@ <a NAME="batchVultureCheck" ID="batchVultureCheck"></a> <h2>batchVultureCheck</h2> <b>batchVultureCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>) - <p> Module function to analyze a batch of files. </p> + <dl> <dt><i>argumentsList</i> (list)</dt> @@ -210,10 +207,10 @@ <a NAME="initBatchService" ID="initBatchService"></a> <h2>initBatchService</h2> <b>initBatchService</b>(<i></i>) - <p> Initialize the batch service and return the entry point. </p> + <dl> <dt>Return:</dt> <dd> @@ -232,10 +229,10 @@ <a NAME="initService" ID="initService"></a> <h2>initService</h2> <b>initService</b>(<i></i>) - <p> Initialize the service and return the entry point. </p> + <dl> <dt>Return:</dt> <dd> @@ -254,10 +251,10 @@ <a NAME="vultureCheck" ID="vultureCheck"></a> <h2>vultureCheck</h2> <b>vultureCheck</b>(<i>file, text=""</i>) - <p> Private function to analyze one file. </p> + <dl> <dt><i>file</i> (str)</dt> @@ -287,10 +284,10 @@ <a NAME="workerTask" ID="workerTask"></a> <h2>workerTask</h2> <b>workerTask</b>(<i>inputQueue, outputQueue</i>) - <p> Module function acting as the parallel worker for the vulture check. </p> + <dl> <dt><i>inputQueue</i> (multiprocessing.Queue)</dt> @@ -304,4 +301,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>