diff -r 022f0bc87198 -r 6124794c3ffe PyLint/Documentation/source/Plugin_Checker_PyLint.PyLint.PyLintExecDialog.html
--- a/PyLint/Documentation/source/Plugin_Checker_PyLint.PyLint.PyLintExecDialog.html Mon May 04 17:51:42 2020 +0200
+++ b/PyLint/Documentation/source/Plugin_Checker_PyLint.PyLint.PyLintExecDialog.html Mon Jun 22 19:49:17 2020 +0200
@@ -18,210 +18,281 @@
</style>
</head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
<h1>Plugin_Checker_PyLint.PyLint.PyLintExecDialog</h1>
+
<p>
Module implementing a dialog to show the results of the PyLint run.
</p>
<h3>Global Attributes</h3>
+
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
+
<table>
+
<tr>
<td><a href="#PyLintExecDialog">PyLintExecDialog</a></td>
<td>Class implementing a dialog to show the results of the PyLint run.</td>
</tr>
</table>
<h3>Functions</h3>
+
<table>
<tr><td>None</td></tr>
</table>
-<hr /><hr />
+<hr />
+<hr />
<a NAME="PyLintExecDialog" ID="PyLintExecDialog"></a>
<h2>PyLintExecDialog</h2>
+
<p>
Class implementing a dialog to show the results of the PyLint run.
-</p><p>
+</p>
+<p>
This class starts a QProcess and displays a dialog that
shows the results of the PyLint command process.
</p>
<h3>Derived from</h3>
QWidget, Ui_PyLintExecDialog
<h3>Class Attributes</h3>
+
<table>
<tr><td>filenameRole</td></tr>
</table>
<h3>Class Methods</h3>
+
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
+
<table>
+
<tr>
<td><a href="#PyLintExecDialog.__init__">PyLintExecDialog</a></td>
<td>Constructor</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#PyLintExecDialog.__createItem">__createItem</a></td>
<td>Private method to create an entry in the message list.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#PyLintExecDialog.__finish">__finish</a></td>
<td>Private slot called when the process finished.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#PyLintExecDialog.__readParseStdout">__readParseStdout</a></td>
<td>Private slot to handle the readyReadStandardOutput signal for parseable output.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#PyLintExecDialog.__readStderr">__readStderr</a></td>
<td>Private slot to handle the readyReadStandardError signal.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#PyLintExecDialog.__readStdout">__readStdout</a></td>
<td>Private slot to handle the readyReadStandardOutput signal.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#PyLintExecDialog.__writeReport">__writeReport</a></td>
<td>Private slot to write the report to a report file.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#PyLintExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
<td>Private slot called by a button of the button box clicked.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#PyLintExecDialog.on_messageList_itemActivated">on_messageList_itemActivated</a></td>
<td>Private slot to handle the itemActivated signal of the message list.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#PyLintExecDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
<td>Private slot to refresh the status display.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#PyLintExecDialog.on_saveButton_clicked">on_saveButton_clicked</a></td>
<td>Private slot to save the report to a file.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#PyLintExecDialog.start">start</a></td>
<td>Public slot to start PyLint.</td>
</tr>
</table>
<h3>Static Methods</h3>
+
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="PyLintExecDialog.__init__" ID="PyLintExecDialog.__init__"></a>
<h4>PyLintExecDialog (Constructor)</h4>
<b>PyLintExecDialog</b>(<i>parent=None</i>)
+
<p>
Constructor
-</p><dl>
+</p>
+<dl>
+
<dt><i>parent</i></dt>
<dd>
parent widget of this dialog (QWidget)
</dd>
-</dl><a NAME="PyLintExecDialog.__createItem" ID="PyLintExecDialog.__createItem"></a>
+</dl>
+<a NAME="PyLintExecDialog.__createItem" ID="PyLintExecDialog.__createItem"></a>
<h4>PyLintExecDialog.__createItem</h4>
<b>__createItem</b>(<i>file, line, type_, message</i>)
+
<p>
Private method to create an entry in the message list.
-</p><dl>
+</p>
+<dl>
+
<dt><i>file</i></dt>
<dd>
filename of file (string)
-</dd><dt><i>line</i></dt>
+</dd>
+<dt><i>line</i></dt>
<dd>
linenumber of message (integer or string)
-</dd><dt><i>type_</i></dt>
+</dd>
+<dt><i>type_</i></dt>
<dd>
type of message (string)
-</dd><dt><i>message</i></dt>
+</dd>
+<dt><i>message</i></dt>
<dd>
message text (string)
</dd>
-</dl><a NAME="PyLintExecDialog.__finish" ID="PyLintExecDialog.__finish"></a>
+</dl>
+<a NAME="PyLintExecDialog.__finish" ID="PyLintExecDialog.__finish"></a>
<h4>PyLintExecDialog.__finish</h4>
<b>__finish</b>(<i></i>)
+
<p>
Private slot called when the process finished.
-</p><p>
+</p>
+<p>
It is called when the process finished or
the user pressed the button.
-</p><a NAME="PyLintExecDialog.__readParseStdout" ID="PyLintExecDialog.__readParseStdout"></a>
+</p>
+<a NAME="PyLintExecDialog.__readParseStdout" ID="PyLintExecDialog.__readParseStdout"></a>
<h4>PyLintExecDialog.__readParseStdout</h4>
<b>__readParseStdout</b>(<i></i>)
+
<p>
Private slot to handle the readyReadStandardOutput signal for
parseable output.
-</p><p>
+</p>
+<p>
It reads the output of the process, formats it and inserts it into
the message list pane.
-</p><a NAME="PyLintExecDialog.__readStderr" ID="PyLintExecDialog.__readStderr"></a>
+</p>
+<a NAME="PyLintExecDialog.__readStderr" ID="PyLintExecDialog.__readStderr"></a>
<h4>PyLintExecDialog.__readStderr</h4>
<b>__readStderr</b>(<i></i>)
+
<p>
Private slot to handle the readyReadStandardError signal.
-</p><p>
+</p>
+<p>
It reads the error output of the process and inserts it into the
error pane.
-</p><a NAME="PyLintExecDialog.__readStdout" ID="PyLintExecDialog.__readStdout"></a>
+</p>
+<a NAME="PyLintExecDialog.__readStdout" ID="PyLintExecDialog.__readStdout"></a>
<h4>PyLintExecDialog.__readStdout</h4>
<b>__readStdout</b>(<i></i>)
+
<p>
Private slot to handle the readyReadStandardOutput signal.
-</p><p>
+</p>
+<p>
It reads the output of the process, formats it and inserts it into
the contents pane.
-</p><a NAME="PyLintExecDialog.__writeReport" ID="PyLintExecDialog.__writeReport"></a>
+</p>
+<a NAME="PyLintExecDialog.__writeReport" ID="PyLintExecDialog.__writeReport"></a>
<h4>PyLintExecDialog.__writeReport</h4>
<b>__writeReport</b>(<i></i>)
+
<p>
Private slot to write the report to a report file.
-</p><a NAME="PyLintExecDialog.on_buttonBox_clicked" ID="PyLintExecDialog.on_buttonBox_clicked"></a>
+</p>
+<a NAME="PyLintExecDialog.on_buttonBox_clicked" ID="PyLintExecDialog.on_buttonBox_clicked"></a>
<h4>PyLintExecDialog.on_buttonBox_clicked</h4>
<b>on_buttonBox_clicked</b>(<i>button</i>)
+
<p>
Private slot called by a button of the button box clicked.
-</p><dl>
+</p>
+<dl>
+
<dt><i>button</i></dt>
<dd>
button that was clicked (QAbstractButton)
</dd>
-</dl><a NAME="PyLintExecDialog.on_messageList_itemActivated" ID="PyLintExecDialog.on_messageList_itemActivated"></a>
+</dl>
+<a NAME="PyLintExecDialog.on_messageList_itemActivated" ID="PyLintExecDialog.on_messageList_itemActivated"></a>
<h4>PyLintExecDialog.on_messageList_itemActivated</h4>
<b>on_messageList_itemActivated</b>(<i>itm, column</i>)
+
<p>
Private slot to handle the itemActivated signal of the message list.
-</p><dl>
+</p>
+<dl>
+
<dt><i>itm</i></dt>
<dd>
The message item that was activated (QTreeWidgetItem)
-</dd><dt><i>column</i></dt>
+</dd>
+<dt><i>column</i></dt>
<dd>
column the item was activated in (integer)
</dd>
-</dl><a NAME="PyLintExecDialog.on_refreshButton_clicked" ID="PyLintExecDialog.on_refreshButton_clicked"></a>
+</dl>
+<a NAME="PyLintExecDialog.on_refreshButton_clicked" ID="PyLintExecDialog.on_refreshButton_clicked"></a>
<h4>PyLintExecDialog.on_refreshButton_clicked</h4>
<b>on_refreshButton_clicked</b>(<i></i>)
+
<p>
Private slot to refresh the status display.
-</p><a NAME="PyLintExecDialog.on_saveButton_clicked" ID="PyLintExecDialog.on_saveButton_clicked"></a>
+</p>
+<a NAME="PyLintExecDialog.on_saveButton_clicked" ID="PyLintExecDialog.on_saveButton_clicked"></a>
<h4>PyLintExecDialog.on_saveButton_clicked</h4>
<b>on_saveButton_clicked</b>(<i></i>)
+
<p>
Private slot to save the report to a file.
-</p><a NAME="PyLintExecDialog.start" ID="PyLintExecDialog.start"></a>
+</p>
+<a NAME="PyLintExecDialog.start" ID="PyLintExecDialog.start"></a>
<h4>PyLintExecDialog.start</h4>
<b>start</b>(<i>args, fn, reportFile, ppath</i>)
+
<p>
Public slot to start PyLint.
-</p><dl>
+</p>
+<dl>
+
<dt><i>args</i></dt>
<dd>
commandline arguments for documentation programPyLint
(list of strings)
-</dd><dt><i>fn</i></dt>
+</dd>
+<dt><i>fn</i></dt>
<dd>
filename or dirname to be processed by PyLint (string)
-</dd><dt><i>reportFile</i></dt>
+</dd>
+<dt><i>reportFile</i></dt>
<dd>
filename of file to write the report to (string)
-</dd><dt><i>ppath</i></dt>
+</dd>
+<dt><i>ppath</i></dt>
<dd>
project path (string)
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Returns:</dt>
<dd>
flag indicating the successful start of the process (boolean)
