Mercurial Repositories > eric / file diff

--- a/eric7/Documentation/Source/eric7.DataViews.PyCoverageDialog.html	Mon May 23 17:31:02 2022 +0200
+++ b/eric7/Documentation/Source/eric7.DataViews.PyCoverageDialog.html	Mon May 23 18:15:10 2022 +0200
@@ -38,6 +38,14 @@
 <p>
     Class implementing a dialog to display the collected code coverage data.
 </p>
+<h3>Signals</h3>
+<dl>
+
+<dt>openFile(str)</dt>
+<dd>
+emitted to open the given file in an editor
+</dd>
+</dl>
 <h3>Derived from</h3>
 QDialog, Ui_PyCoverageDialog
 <h3>Class Attributes</h3>
@@ -59,22 +67,10 @@
 <td>Constructor</td>
 </tr>
 <tr>
-<td><a href="#PyCoverageDialog.__annotate">__annotate</a></td>
-<td>Private slot to handle the annotate context menu action.</td>
-</tr>
-<tr>
-<td><a href="#PyCoverageDialog.__annotateAll">__annotateAll</a></td>
-<td>Private slot to handle the annotate all context menu action.</td>
-</tr>
-<tr>
 <td><a href="#PyCoverageDialog.__createResultItem">__createResultItem</a></td>
 <td>Private method to create an entry in the result list.</td>
 </tr>
 <tr>
-<td><a href="#PyCoverageDialog.__deleteAnnotated">__deleteAnnotated</a></td>
-<td>Private slot to handle the delete annotated context menu action.</td>
-</tr>
-<tr>
 <td><a href="#PyCoverageDialog.__erase">__erase</a></td>
 <td>Private slot to handle the erase context menu action.</td>
 </tr>
@@ -87,10 +83,26 @@
 <td>Private method to format a list of integers into string by coalescing groups.</td>
 </tr>
 <tr>
+<td><a href="#PyCoverageDialog.__htmlReport">__htmlReport</a></td>
+<td>Private slot to generate a HTML report of the shown data.</td>
+</tr>
+<tr>
+<td><a href="#PyCoverageDialog.__jsonReport">__jsonReport</a></td>
+<td>Private slot to generate a JSON report of the shown data.</td>
+</tr>
+<tr>
+<td><a href="#PyCoverageDialog.__lcovReport">__lcovReport</a></td>
+<td>Private slot to generate a LCOV report of the shown data.</td>
+</tr>
+<tr>
 <td><a href="#PyCoverageDialog.__openFile">__openFile</a></td>
 <td>Private slot to open the selected file.</td>
 </tr>
 <tr>
+<td><a href="#PyCoverageDialog.__prepareReportGeneration">__prepareReportGeneration</a></td>
+<td>Private method to prepare a report generation.</td>
+</tr>
+<tr>
 <td><a href="#PyCoverageDialog.__showContextMenu">__showContextMenu</a></td>
 <td>Private slot to show the context menu of the listview.</td>
 </tr>
@@ -130,33 +142,11 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget (QWidget)
+parent widget
 </dd>
 </dl>
-<a NAME="PyCoverageDialog.__annotate" ID="PyCoverageDialog.__annotate"></a>
-<h4>PyCoverageDialog.__annotate</h4>
-<b>__annotate</b>(<i></i>)
-
-<p>
-        Private slot to handle the annotate context menu action.
-</p>
-<p>
-        This method produce an annotated coverage file of the
-        selected file.
-</p>
-<a NAME="PyCoverageDialog.__annotateAll" ID="PyCoverageDialog.__annotateAll"></a>
-<h4>PyCoverageDialog.__annotateAll</h4>
-<b>__annotateAll</b>(<i></i>)
-
-<p>
-        Private slot to handle the annotate all context menu action.
-</p>
-<p>
-        This method produce an annotated coverage file of every
-        file listed in the listview.
-</p>
 <a NAME="PyCoverageDialog.__createResultItem" ID="PyCoverageDialog.__createResultItem"></a>
 <h4>PyCoverageDialog.__createResultItem</h4>
 <b>__createResultItem</b>(<i>file, statements, executed, coverage, excluded, missing</i>)
@@ -166,42 +156,31 @@
 </p>
 <dl>
 
-<dt><i>file</i></dt>
+<dt><i>file</i> (str)</dt>
 <dd>
-filename of file (string)
+filename of file
 </dd>
-<dt><i>statements</i></dt>
+<dt><i>statements</i> (int)</dt>
 <dd>
-amount of statements (integer)
+number of statements
 </dd>
-<dt><i>executed</i></dt>
+<dt><i>executed</i> (int)</dt>
 <dd>
-amount of executed statements (integer)
+number of executed statements
 </dd>
-<dt><i>coverage</i></dt>
+<dt><i>coverage</i> (int)</dt>
 <dd>
-percent of coverage (integer)
+percent of coverage
 </dd>
-<dt><i>excluded</i></dt>
+<dt><i>excluded</i> (str)</dt>
 <dd>
-list of excluded lines (string)
+list of excluded lines
 </dd>
-<dt><i>missing</i></dt>
+<dt><i>missing</i> (str)</dt>
 <dd>
-list of lines without coverage (string)
+list of lines without coverage
 </dd>
 </dl>
-<a NAME="PyCoverageDialog.__deleteAnnotated" ID="PyCoverageDialog.__deleteAnnotated"></a>
-<h4>PyCoverageDialog.__deleteAnnotated</h4>
-<b>__deleteAnnotated</b>(<i></i>)
-
-<p>
-        Private slot to handle the delete annotated context menu action.
-</p>
-<p>
-        This method deletes all annotated files. These are files
-        ending with ',cover'.
-</p>
 <a NAME="PyCoverageDialog.__erase" ID="PyCoverageDialog.__erase"></a>
 <h4>PyCoverageDialog.__erase</h4>
 <b>__erase</b>(<i></i>)
@@ -231,7 +210,7 @@
 </p>
 <dl>
 
-<dt><i>lines</i></dt>
+<dt><i>lines</i> (list of int)</dt>
 <dd>
 list of integers
 </dd>
@@ -242,6 +221,33 @@
 string representing the list
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="PyCoverageDialog.__htmlReport" ID="PyCoverageDialog.__htmlReport"></a>
+<h4>PyCoverageDialog.__htmlReport</h4>
+<b>__htmlReport</b>(<i></i>)
+
+<p>
+        Private slot to generate a HTML report of the shown data.
+</p>
+<a NAME="PyCoverageDialog.__jsonReport" ID="PyCoverageDialog.__jsonReport"></a>
+<h4>PyCoverageDialog.__jsonReport</h4>
+<b>__jsonReport</b>(<i></i>)
+
+<p>
+        Private slot to generate a JSON report of the shown data.
+</p>
+<a NAME="PyCoverageDialog.__lcovReport" ID="PyCoverageDialog.__lcovReport"></a>
+<h4>PyCoverageDialog.__lcovReport</h4>
+<b>__lcovReport</b>(<i></i>)
+
+<p>
+        Private slot to generate a LCOV report of the shown data.
+</p>
 <a NAME="PyCoverageDialog.__openFile" ID="PyCoverageDialog.__openFile"></a>
 <h4>PyCoverageDialog.__openFile</h4>
 <b>__openFile</b>(<i>itm=None</i>)
@@ -251,9 +257,29 @@
 </p>
 <dl>
 
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (QTreeWidgetItem)</dt>
 <dd>
-reference to the item to be opened (QTreeWidgetItem)
+reference to the item to be opened
+</dd>
+</dl>
+<a NAME="PyCoverageDialog.__prepareReportGeneration" ID="PyCoverageDialog.__prepareReportGeneration"></a>
+<h4>PyCoverageDialog.__prepareReportGeneration</h4>
+<b>__prepareReportGeneration</b>(<i></i>)
+
+<p>
+        Private method to prepare a report generation.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing a reference to the Coverage object and the
+            list of files to report
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (Coverage, list of str)
 </dd>
 </dl>
 <a NAME="PyCoverageDialog.__showContextMenu" ID="PyCoverageDialog.__showContextMenu"></a>
@@ -265,9 +291,9 @@
 </p>
 <dl>
 
-<dt><i>coord</i></dt>
+<dt><i>coord</i> (QPoint)</dt>
 <dd>
-the position of the mouse pointer (QPoint)
+position of the mouse pointer
 </dd>
 </dl>
 <a NAME="PyCoverageDialog.on_buttonBox_clicked" ID="PyCoverageDialog.on_buttonBox_clicked"></a>
@@ -279,9 +305,9 @@
 </p>
 <dl>
 
-<dt><i>button</i></dt>
+<dt><i>button</i> (QAbstractButton)</dt>
 <dd>
-button that was clicked (QAbstractButton)
+button that was clicked
 </dd>
 </dl>
 <a NAME="PyCoverageDialog.on_reloadButton_clicked" ID="PyCoverageDialog.on_reloadButton_clicked"></a>
@@ -318,14 +344,13 @@
 </p>
 <dl>
 
-<dt><i>cfn</i></dt>
+<dt><i>cfn</i> (str)</dt>
 <dd>
-basename of the coverage file (string)
+basename of the coverage file
 </dd>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str or list of str)</dt>
 <dd>
 file or list of files or directory to be checked
-                (string or list of strings)
 </dd>
 </dl>
 <a NAME="PyCoverageDialog.stringify" ID="PyCoverageDialog.stringify"></a>
@@ -338,11 +363,23 @@
 </p>
 <dl>
 
-<dt><i>pair</i></dt>
+<dt><i>pair</i> (tuple of (int, int)</dt>
 <dd>
 pair of integers
 </dd>
 </dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+representation of the pair
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file