diff -r 2409ad7298d6 -r b6622920a278 VultureChecker/Documentation/source/Plugin_Checker_Vulture.PluginVulture.html
--- a/VultureChecker/Documentation/source/Plugin_Checker_Vulture.PluginVulture.html Sat Dec 23 16:08:42 2023 +0100
+++ b/VultureChecker/Documentation/source/Plugin_Checker_Vulture.PluginVulture.html Mon Apr 22 16:13:31 2024 +0200
@@ -7,41 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Checker_Vulture.PluginVulture</h1>
-
<p>
Module implementing the vulture plug-in.
</p>
+
<h3>Global Attributes</h3>
-
<table>
-<tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
+<tr><td>author</td></tr>
+<tr><td>autoactivate</td></tr>
+<tr><td>className</td></tr>
+<tr><td>deactivateable</td></tr>
+<tr><td>error</td></tr>
+<tr><td>longDescription</td></tr>
+<tr><td>name</td></tr>
+<tr><td>needsRestart</td></tr>
+<tr><td>packageName</td></tr>
+<tr><td>pyqtApi</td></tr>
+<tr><td>shortDescription</td></tr>
+<tr><td>version</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#VulturePlugin">VulturePlugin</a></td>
<td>Class documentation goes here.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#installDependencies">installDependencies</a></td>
<td>Function to install dependencies of this plug-in.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="VulturePlugin" ID="VulturePlugin"></a>
<h2>VulturePlugin</h2>
-
<p>
Class documentation goes here.
</p>
+
<h3>Signals</h3>
<dl>
@@ -62,19 +71,17 @@
<h3>Derived from</h3>
QObject
<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="#VulturePlugin.__init__">VulturePlugin</a></td>
<td>Constructor</td>
@@ -136,19 +143,20 @@
<td>Public slot to dispatch the result.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="VulturePlugin.__init__" ID="VulturePlugin.__init__"></a>
<h4>VulturePlugin (Constructor)</h4>
<b>VulturePlugin</b>(<i>ui</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>ui</i> (UserInterface)</dt>
@@ -159,32 +167,32 @@
<a NAME="VulturePlugin.__initialize" ID="VulturePlugin.__initialize"></a>
<h4>VulturePlugin.__initialize</h4>
<b>__initialize</b>(<i></i>)
-
<p>
Private slot to (re)initialize the plug-in.
</p>
+
<a NAME="VulturePlugin.__loadTranslator" ID="VulturePlugin.__loadTranslator"></a>
<h4>VulturePlugin.__loadTranslator</h4>
<b>__loadTranslator</b>(<i></i>)
-
<p>
Private method to load the translation file.
</p>
+
<a NAME="VulturePlugin.__projectClosed" ID="VulturePlugin.__projectClosed"></a>
<h4>VulturePlugin.__projectClosed</h4>
<b>__projectClosed</b>(<i></i>)
-
<p>
Private slot to handle closing a project.
</p>
+
<a NAME="VulturePlugin.__projectShowMenu" ID="VulturePlugin.__projectShowMenu"></a>
<h4>VulturePlugin.__projectShowMenu</h4>
<b>__projectShowMenu</b>(<i>menuName, menu, </i>)
-
<p>
Private slot called, when the the project menu or a submenu is
about to be shown.
</p>
+
<dl>
<dt><i>menuName</i> (str)</dt>
@@ -199,17 +207,17 @@
<a NAME="VulturePlugin.__projectVultureCheck" ID="VulturePlugin.__projectVultureCheck"></a>
<h4>VulturePlugin.__projectVultureCheck</h4>
<b>__projectVultureCheck</b>(<i></i>)
-
<p>
Private slot used to check the project for unused code.
</p>
+
<a NAME="VulturePlugin.__serviceError" ID="VulturePlugin.__serviceError"></a>
<h4>VulturePlugin.__serviceError</h4>
<b>__serviceError</b>(<i>fn, msg</i>)
-
<p>
Private slot handling service errors.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -224,10 +232,10 @@
<a NAME="VulturePlugin.activate" ID="VulturePlugin.activate"></a>
<h4>VulturePlugin.activate</h4>
<b>activate</b>(<i></i>)
-
<p>
Public method to activate this plug-in.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -243,10 +251,10 @@
<a NAME="VulturePlugin.batchJobDone" ID="VulturePlugin.batchJobDone"></a>
<h4>VulturePlugin.batchJobDone</h4>
<b>batchJobDone</b>(<i>fx, lang</i>)
-
<p>
Public slot handling the completion of a batch job.
</p>
+
<dl>
<dt><i>fx</i> (str)</dt>
@@ -261,24 +269,24 @@
<a NAME="VulturePlugin.cancelVultureCheckBatch" ID="VulturePlugin.cancelVultureCheckBatch"></a>
<h4>VulturePlugin.cancelVultureCheckBatch</h4>
<b>cancelVultureCheckBatch</b>(<i></i>)
-
<p>
Public method to cancel all batch jobs.
</p>
+
<a NAME="VulturePlugin.deactivate" ID="VulturePlugin.deactivate"></a>
<h4>VulturePlugin.deactivate</h4>
<b>deactivate</b>(<i></i>)
-
<p>
Public method to deactivate this plug-in.
</p>
+
<a NAME="VulturePlugin.serviceErrorPy3" ID="VulturePlugin.serviceErrorPy3"></a>
<h4>VulturePlugin.serviceErrorPy3</h4>
<b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>)
-
<p>
Public slot handling service errors for Python 3.
</p>
+
<dl>
<dt><i>fx</i> (str)</dt>
@@ -301,10 +309,10 @@
<a NAME="VulturePlugin.vultureCheck" ID="VulturePlugin.vultureCheck"></a>
<h4>VulturePlugin.vultureCheck</h4>
<b>vultureCheck</b>(<i>lang, filename, source</i>)
-
<p>
Public method to prepare a vulture check for a Python project.
</p>
+
<dl>
<dt><i>lang</i> (str or None)</dt>
@@ -324,11 +332,11 @@
<a NAME="VulturePlugin.vultureCheckBatch" ID="VulturePlugin.vultureCheckBatch"></a>
<h4>VulturePlugin.vultureCheckBatch</h4>
<b>vultureCheckBatch</b>(<i>argumentsList</i>)
-
<p>
Public method to prepare a vulture check for a Python project using
the batch mode.
</p>
+
<dl>
<dt><i>argumentsList</i> ((str, str))</dt>
@@ -340,10 +348,10 @@
<a NAME="VulturePlugin.vultureCheckDone" ID="VulturePlugin.vultureCheckDone"></a>
<h4>VulturePlugin.vultureCheckDone</h4>
<b>vultureCheckDone</b>(<i>filename, result</i>)
-
<p>
Public slot to dispatch the result.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -361,10 +369,10 @@
<a NAME="installDependencies" ID="installDependencies"></a>
<h2>installDependencies</h2>
<b>installDependencies</b>(<i>pipInstall</i>)
-
<p>
Function to install dependencies of this plug-in.
</p>
+
<dl>
<dt><i>pipInstall</i> (function)</dt>
@@ -374,4 +382,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
