diff -r 9d01e990bb27 -r 4a69da851bd2 VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerService.html
--- a/VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerService.html Wed Jan 01 11:58:52 2020 +0100
+++ b/VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerService.html Tue Jun 23 17:33:21 2020 +0200
@@ -18,226 +18,289 @@
</style>
</head>
-<body><a NAME="top" ID="top"></a>
+<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>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#batchVultureCheck">batchVultureCheck</a></td>
<td>Module function to analyze a batch of files.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#initBatchService">initBatchService</a></td>
<td>Initialize the batch service and return the entry point.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#initService">initService</a></td>
<td>Initialize the service and return the entry point.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#vultureCheck">vultureCheck</a></td>
<td>Private function to analyze one file.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#worker">worker</a></td>
<td>Module function acting as the parallel worker for the cyclomatic complexity calculation.</td>
</tr>
</table>
-<hr /><hr />
+<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>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#EricVulture.getResults">getResults</a></td>
<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>
+</p>
+<dl>
+
<dt><i>item</i> (vulture.Item)</dt>
<dd>
vulture item
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Returns:</dt>
<dd>
item dictionary
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
-</dl><a NAME="EricVulture.getResults" ID="EricVulture.getResults"></a>
+</dl>
+<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>
+</p>
+<dl>
<dt>Returns:</dt>
<dd>
scan results
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
<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>
+</p>
+<dl>
+
<dt><i>filename</i> (str)</dt>
<dd>
source file name
-</dd><dt><i>text</i> (str)</dt>
+</dd>
+<dt><i>text</i> (str)</dt>
<dd>
source text
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Returns:</dt>
<dd>
tuple containing the result dictionary
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Return Type:</dt>
<dd>
(tuple of dict)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
<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>
+</p>
+<dl>
+
<dt><i>argumentsList</i> (list)</dt>
<dd>
list of arguments tuples as given for vultureCheck
-</dd><dt><i>send</i> (function)</dt>
+</dd>
+<dt><i>send</i> (function)</dt>
<dd>
reference to send function
-</dd><dt><i>fx</i> (str)</dt>
+</dd>
+<dt><i>fx</i> (str)</dt>
<dd>
registered service name
-</dd><dt><i>cancelled</i> (function)</dt>
+</dd>
+<dt><i>cancelled</i> (function)</dt>
<dd>
reference to function checking for a cancellation
-</dd><dt><i>maxProcesses</i> (int)</dt>
+</dd>
+<dt><i>maxProcesses</i> (int)</dt>
<dd>
number of processes to be used
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
<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>
+</p>
+<dl>
<dt>Returns:</dt>
<dd>
the entry point for the background client (function)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
<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>
+</p>
+<dl>
<dt>Returns:</dt>
<dd>
the entry point for the background client (function)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
<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>
+</p>
+<dl>
+
<dt><i>file</i> (str)</dt>
<dd>
source filename
-</dd><dt><i>text</i> (str)</dt>
+</dd>
+<dt><i>text</i> (str)</dt>
<dd>
source text
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Returns:</dt>
<dd>
tuple containing the result dictionary
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Return Type:</dt>
<dd>
(tuple of dict)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
<a NAME="worker" ID="worker"></a>
<h2>worker</h2>
<b>worker</b>(<i>inputQueue, outputQueue</i>)
+
<p>
Module function acting as the parallel worker for the cyclomatic
complexity calculation.
-</p><dl>
+</p>
+<dl>
+
<dt><i>inputQueue</i> (multiprocessing.Queue)</dt>
<dd>
input queue
-</dd><dt><i>outputQueue</i> (multiprocessing.Queue)</dt>
+</dd>
+<dt><i>outputQueue</i> (multiprocessing.Queue)</dt>
<dd>
output queue
</dd>
