--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PyrightChecker/Documentation/Source/Plugin_Checker_Pyright.PluginPyright.html	Tue Nov 07 15:17:48 2023 +0100
@@ -0,0 +1,319 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Checker_Pyright.PluginPyright</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Checker_Pyright.PluginPyright</h1>
+
+<p>
+Module implementing the pyright plug-in.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>__header__</td></tr><tr><td>error</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#PyrightPlugin">PyrightPlugin</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>
+<tr>
+<td><a href="#prepareUninstall">prepareUninstall</a></td>
+<td>Module function to prepare for an uninstallation.</td>
+</tr>
+</table>
+<hr />
+<hr />
+<a NAME="PyrightPlugin" ID="PyrightPlugin"></a>
+<h2>PyrightPlugin</h2>
+
+<p>
+    Class documentation goes here.
+</p>
+<h3>Derived from</h3>
+QObject
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>PreferencesKey</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#PyrightPlugin.__init__">PyrightPlugin</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PyrightPlugin.__editorClosed">__editorClosed</a></td>
+<td>Private slot called, when an editor was closed.</td>
+</tr>
+<tr>
+<td><a href="#PyrightPlugin.__editorOpened">__editorOpened</a></td>
+<td>Private slot called, when a new editor was opened.</td>
+</tr>
+<tr>
+<td><a href="#PyrightPlugin.__editorPyrightCheck">__editorPyrightCheck</a></td>
+<td>Private slot to handle the code style check context menu action of the editors.</td>
+</tr>
+<tr>
+<td><a href="#PyrightPlugin.__editorShowMenu">__editorShowMenu</a></td>
+<td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td>
+</tr>
+<tr>
+<td><a href="#PyrightPlugin.__initialize">__initialize</a></td>
+<td>Private slot to (re)initialize the plug-in.</td>
+</tr>
+<tr>
+<td><a href="#PyrightPlugin.__loadTranslator">__loadTranslator</a></td>
+<td>Private method to load the translation file.</td>
+</tr>
+<tr>
+<td><a href="#PyrightPlugin.__projectBrowserPyrightCheck">__projectBrowserPyrightCheck</a></td>
+<td>Private method to handle the static typing check context menu action of the project sources browser.</td>
+</tr>
+<tr>
+<td><a href="#PyrightPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td>
+<td>Private slot called, when the the project browser menu or a submenu is about to be shown.</td>
+</tr>
+<tr>
+<td><a href="#PyrightPlugin.__projectPyrightCheck">__projectPyrightCheck</a></td>
+<td>Private slot used to check the project for static typing issues.</td>
+</tr>
+<tr>
+<td><a href="#PyrightPlugin.__projectShowMenu">__projectShowMenu</a></td>
+<td>Private slot called, when the the project menu or a submenu is about to be shown.</td>
+</tr>
+<tr>
+<td><a href="#PyrightPlugin.activate">activate</a></td>
+<td>Public method to activate this plug-in.</td>
+</tr>
+<tr>
+<td><a href="#PyrightPlugin.deactivate">deactivate</a></td>
+<td>Public method to deactivate this plug-in.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="PyrightPlugin.__init__" ID="PyrightPlugin.__init__"></a>
+<h4>PyrightPlugin (Constructor)</h4>
+<b>PyrightPlugin</b>(<i>ui</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>ui</i> (UI.UserInterface)</dt>
+<dd>
+reference to the user interface object
+</dd>
+</dl>
+<a NAME="PyrightPlugin.__editorClosed" ID="PyrightPlugin.__editorClosed"></a>
+<h4>PyrightPlugin.__editorClosed</h4>
+<b>__editorClosed</b>(<i>editor</i>)
+
+<p>
+        Private slot called, when an editor was closed.
+</p>
+<dl>
+
+<dt><i>editor</i> (QScintilla.Editor)</dt>
+<dd>
+reference to the editor
+</dd>
+</dl>
+<a NAME="PyrightPlugin.__editorOpened" ID="PyrightPlugin.__editorOpened"></a>
+<h4>PyrightPlugin.__editorOpened</h4>
+<b>__editorOpened</b>(<i>editor</i>)
+
+<p>
+        Private slot called, when a new editor was opened.
+</p>
+<dl>
+
+<dt><i>editor</i> (QScintilla.Editor)</dt>
+<dd>
+reference to the new editor
+</dd>
+</dl>
+<a NAME="PyrightPlugin.__editorPyrightCheck" ID="PyrightPlugin.__editorPyrightCheck"></a>
+<h4>PyrightPlugin.__editorPyrightCheck</h4>
+<b>__editorPyrightCheck</b>(<i></i>)
+
+<p>
+        Private slot to handle the code style check context menu action
+        of the editors.
+</p>
+<a NAME="PyrightPlugin.__editorShowMenu" ID="PyrightPlugin.__editorShowMenu"></a>
+<h4>PyrightPlugin.__editorShowMenu</h4>
+<b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
+
+<p>
+        Private slot called, when the the editor context menu or a submenu is
+        about to be shown.
+</p>
+<dl>
+
+<dt><i>menuName</i> (str)</dt>
+<dd>
+name of the menu to be shown
+</dd>
+<dt><i>menu</i> (QMenu)</dt>
+<dd>
+reference to the menu
+</dd>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
+<dd>
+reference to the editor
+</dd>
+</dl>
+<a NAME="PyrightPlugin.__initialize" ID="PyrightPlugin.__initialize"></a>
+<h4>PyrightPlugin.__initialize</h4>
+<b>__initialize</b>(<i></i>)
+
+<p>
+        Private slot to (re)initialize the plug-in.
+</p>
+<a NAME="PyrightPlugin.__loadTranslator" ID="PyrightPlugin.__loadTranslator"></a>
+<h4>PyrightPlugin.__loadTranslator</h4>
+<b>__loadTranslator</b>(<i></i>)
+
+<p>
+        Private method to load the translation file.
+</p>
+<a NAME="PyrightPlugin.__projectBrowserPyrightCheck" ID="PyrightPlugin.__projectBrowserPyrightCheck"></a>
+<h4>PyrightPlugin.__projectBrowserPyrightCheck</h4>
+<b>__projectBrowserPyrightCheck</b>(<i></i>)
+
+<p>
+        Private method to handle the static typing check context menu action of
+        the project sources browser.
+</p>
+<a NAME="PyrightPlugin.__projectBrowserShowMenu" ID="PyrightPlugin.__projectBrowserShowMenu"></a>
+<h4>PyrightPlugin.__projectBrowserShowMenu</h4>
+<b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>)
+
+<p>
+        Private slot called, when the the project browser menu or a submenu is
+        about to be shown.
+</p>
+<dl>
+
+<dt><i>menuName</i> (str)</dt>
+<dd>
+name of the menu to be shown
+</dd>
+<dt><i>menu</i> (QMenu)</dt>
+<dd>
+reference to the menu
+</dd>
+</dl>
+<a NAME="PyrightPlugin.__projectPyrightCheck" ID="PyrightPlugin.__projectPyrightCheck"></a>
+<h4>PyrightPlugin.__projectPyrightCheck</h4>
+<b>__projectPyrightCheck</b>(<i></i>)
+
+<p>
+        Private slot used to check the project for static typing issues.
+</p>
+<a NAME="PyrightPlugin.__projectShowMenu" ID="PyrightPlugin.__projectShowMenu"></a>
+<h4>PyrightPlugin.__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>
+<dd>
+name of the menu to be shown
+</dd>
+<dt><i>menu</i> (QMenu)</dt>
+<dd>
+reference to the menu
+</dd>
+</dl>
+<a NAME="PyrightPlugin.activate" ID="PyrightPlugin.activate"></a>
+<h4>PyrightPlugin.activate</h4>
+<b>activate</b>(<i></i>)
+
+<p>
+        Public method to activate this plug-in.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple of None and activation status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="PyrightPlugin.deactivate" ID="PyrightPlugin.deactivate"></a>
+<h4>PyrightPlugin.deactivate</h4>
+<b>deactivate</b>(<i></i>)
+
+<p>
+        Public method to deactivate this plug-in.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<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>
+<dd>
+function to be called with a list of package names.
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="prepareUninstall" ID="prepareUninstall"></a>
+<h2>prepareUninstall</h2>
+<b>prepareUninstall</b>(<i></i>)
+
+<p>
+    Module function to prepare for an uninstallation.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file