src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleStatisticsDialog.html

Thu, 04 Jan 2024 18:02:25 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Thu, 04 Jan 2024 18:02:25 +0100
branch
eric7
changeset 10479
856476537696
parent 9209
b99e7fd55fd3
permissions
-rw-r--r--

Fine tuned the source code documentation template and regenerated the source code documentation.

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleStatisticsDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleStatisticsDialog</h1>
<p>
Module implementing a dialog showing statistical data for the last code
style checker run.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#CodeStyleStatisticsDialog">CodeStyleStatisticsDialog</a></td>
<td>Class implementing a dialog showing statistical data for the last code style checker run.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="CodeStyleStatisticsDialog" ID="CodeStyleStatisticsDialog"></a>
<h2>CodeStyleStatisticsDialog</h2>
<p>
    Class implementing a dialog showing statistical data for the last
    code style checker run.
</p>

<h3>Derived from</h3>
QDialog, Ui_CodeStyleStatisticsDialog
<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="#CodeStyleStatisticsDialog.__init__">CodeStyleStatisticsDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#CodeStyleStatisticsDialog.__createItem">__createItem</a></td>
<td>Private method to create an entry in the result list.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="CodeStyleStatisticsDialog.__init__" ID="CodeStyleStatisticsDialog.__init__"></a>
<h4>CodeStyleStatisticsDialog (Constructor)</h4>
<b>CodeStyleStatisticsDialog</b>(<i>statisticData, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>statisticData</i> (dict)</dt>
<dd>
dictionary with the statistical data
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="CodeStyleStatisticsDialog.__createItem" ID="CodeStyleStatisticsDialog.__createItem"></a>
<h4>CodeStyleStatisticsDialog.__createItem</h4>
<b>__createItem</b>(<i>counts, msgCode, message</i>)
<p>
        Private method to create an entry in the result list.
</p>

<dl>

<dt><i>counts</i> (dict)</dt>
<dd>
dictionary containing the total and ignored occurrences
            of the issue
</dd>
<dt><i>msgCode</i> (str)</dt>
<dd>
code of a code style issue message
</dd>
<dt><i>message</i> (str)</dt>
<dd>
code style issue message to be shown
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial