--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PyLintInterface.PyLintConfigDialog.html	Thu Dec 30 11:37:27 2021 +0100
@@ -0,0 +1,218 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Checker_PyLint.PyLintInterface.PyLintConfigDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Checker_PyLint.PyLintInterface.PyLintConfigDialog</h1>
+
+<p>
+Module implementing a dialog to configure the PyLint process.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#PyLintConfigDialog">PyLintConfigDialog</a></td>
+<td>Class implementing a dialog to configure the PyLint process.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="PyLintConfigDialog" ID="PyLintConfigDialog"></a>
+<h2>PyLintConfigDialog</h2>
+
+<p>
+    Class implementing a dialog to configure the PyLint process.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_PyLintConfigDialog
+<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="#PyLintConfigDialog.__init__">PyLintConfigDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PyLintConfigDialog.__createConfigDone">__createConfigDone</a></td>
+<td>Private slot to handle the the finished signal of the pylint process.</td>
+</tr>
+<tr>
+<td><a href="#PyLintConfigDialog.__initializeDefaults">__initializeDefaults</a></td>
+<td>Private method to set the default values.</td>
+</tr>
+<tr>
+<td><a href="#PyLintConfigDialog.__readStderr">__readStderr</a></td>
+<td>Private slot to handle the readyReadStandardError signal of the pylint process.</td>
+</tr>
+<tr>
+<td><a href="#PyLintConfigDialog.__readStdout">__readStdout</a></td>
+<td>Private slot to handle the readyReadStandardOutput signal of the pylint process.</td>
+</tr>
+<tr>
+<td><a href="#PyLintConfigDialog.accept">accept</a></td>
+<td>Public slot called by the Ok button.</td>
+</tr>
+<tr>
+<td><a href="#PyLintConfigDialog.generateParameters">generateParameters</a></td>
+<td>Public method that generates the commandline parameters.</td>
+</tr>
+<tr>
+<td><a href="#PyLintConfigDialog.on_configButton_clicked">on_configButton_clicked</a></td>
+<td>Private slot to handle the generation of a sample configuration.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="PyLintConfigDialog.__init__" ID="PyLintConfigDialog.__init__"></a>
+<h4>PyLintConfigDialog (Constructor)</h4>
+<b>PyLintConfigDialog</b>(<i>ppath, exe, parms, version</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>ppath</i> (str)</dt>
+<dd>
+project path; used to set the default path for the
+            rcfile picker
+</dd>
+<dt><i>exe</i> (str)</dt>
+<dd>
+name of the pylint executable
+</dd>
+<dt><i>parms</i> (dict)</dt>
+<dd>
+parameters to set in the dialog
+</dd>
+<dt><i>version</i> (str)</dt>
+<dd>
+pylint version (unused)
+</dd>
+</dl>
+<a NAME="PyLintConfigDialog.__createConfigDone" ID="PyLintConfigDialog.__createConfigDone"></a>
+<h4>PyLintConfigDialog.__createConfigDone</h4>
+<b>__createConfigDone</b>(<i>exitCode, exitStatus</i>)
+
+<p>
+        Private slot to handle the the finished signal of the pylint process.
+</p>
+<dl>
+
+<dt><i>exitCode</i> (int)</dt>
+<dd>
+exit code of the process
+</dd>
+<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
+<dd>
+exit status of the process
+</dd>
+</dl>
+<a NAME="PyLintConfigDialog.__initializeDefaults" ID="PyLintConfigDialog.__initializeDefaults"></a>
+<h4>PyLintConfigDialog.__initializeDefaults</h4>
+<b>__initializeDefaults</b>(<i></i>)
+
+<p>
+        Private method to set the default values.
+</p>
+<p>
+        These are needed later on to generate the commandline
+        parameters.
+</p>
+<a NAME="PyLintConfigDialog.__readStderr" ID="PyLintConfigDialog.__readStderr"></a>
+<h4>PyLintConfigDialog.__readStderr</h4>
+<b>__readStderr</b>(<i></i>)
+
+<p>
+        Private slot to handle the readyReadStandardError signal of the
+        pylint process.
+</p>
+<a NAME="PyLintConfigDialog.__readStdout" ID="PyLintConfigDialog.__readStdout"></a>
+<h4>PyLintConfigDialog.__readStdout</h4>
+<b>__readStdout</b>(<i></i>)
+
+<p>
+        Private slot to handle the readyReadStandardOutput signal of the
+        pylint process.
+</p>
+<a NAME="PyLintConfigDialog.accept" ID="PyLintConfigDialog.accept"></a>
+<h4>PyLintConfigDialog.accept</h4>
+<b>accept</b>(<i></i>)
+
+<p>
+        Public slot called by the Ok button.
+</p>
+<p>
+        It saves the values in the parameters dictionary.
+</p>
+<a NAME="PyLintConfigDialog.generateParameters" ID="PyLintConfigDialog.generateParameters"></a>
+<h4>PyLintConfigDialog.generateParameters</h4>
+<b>generateParameters</b>(<i></i>)
+
+<p>
+        Public method that generates the commandline parameters.
+</p>
+<p>
+        It generates a list of strings to be used
+        to set the QProcess arguments for the pylint call and
+        a list containing the non default parameters. The second
+        list can be passed back upon object generation to overwrite
+        the default settings.
+</p>
+<p>
+        <b>Note</b>: The arguments list contains the name of the pylint
+        executable as the first parameter.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+a tuple of the commandline parameters and non default
+            parameters
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (list of str, dict)
+</dd>
+</dl>
+<a NAME="PyLintConfigDialog.on_configButton_clicked" ID="PyLintConfigDialog.on_configButton_clicked"></a>
+<h4>PyLintConfigDialog.on_configButton_clicked</h4>
+<b>on_configButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to handle the generation of a sample configuration.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file