Mercurial Repositories > Radon Code Metrics / file diff

--- a/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CyclomaticComplexityDialog.html	Sat Dec 31 16:27:44 2022 +0100
+++ b/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CyclomaticComplexityDialog.html	Sat May 27 15:33:58 2023 +0200
@@ -65,6 +65,10 @@
 <td>Private slot handling the completion of a batch job.</td>
 </tr>
 <tr>
+<td><a href="#CyclomaticComplexityDialog.__cancel">__cancel</a></td>
+<td>Private method to cancel the current check run.</td>
+</tr>
+<tr>
 <td><a href="#CyclomaticComplexityDialog.__createErrorItem">__createErrorItem</a></td>
 <td>Private slot to create a new error item in the result list.</td>
 </tr>
@@ -109,6 +113,10 @@
 <td>Public method to clear all results.</td>
 </tr>
 <tr>
+<td><a href="#CyclomaticComplexityDialog.closeEvent">closeEvent</a></td>
+<td>Protected method to handle a close event.</td>
+</tr>
+<tr>
 <td><a href="#CyclomaticComplexityDialog.cyclomaticComplexity">cyclomaticComplexity</a></td>
 <td>Public method to start a cyclomatic complexity calculation for one Python file.</td>
 </tr>
@@ -183,6 +191,13 @@
 type of the calculated metrics
 </dd>
 </dl>
+<a NAME="CyclomaticComplexityDialog.__cancel" ID="CyclomaticComplexityDialog.__cancel"></a>
+<h4>CyclomaticComplexityDialog.__cancel</h4>
+<b>__cancel</b>(<i></i>)
+
+<p>
+        Private method to cancel the current check run.
+</p>
 <a NAME="CyclomaticComplexityDialog.__createErrorItem" ID="CyclomaticComplexityDialog.__createErrorItem"></a>
 <h4>CyclomaticComplexityDialog.__createErrorItem</h4>
 <b>__createErrorItem</b>(<i>filename, message</i>)
@@ -335,9 +350,23 @@
 <p>
         Public method to clear all results.
 </p>
+<a NAME="CyclomaticComplexityDialog.closeEvent" ID="CyclomaticComplexityDialog.closeEvent"></a>
+<h4>CyclomaticComplexityDialog.closeEvent</h4>
+<b>closeEvent</b>(<i>evt</i>)
+
+<p>
+        Protected method to handle a close event.
+</p>
+<dl>
+
+<dt><i>evt</i> (QCloseEvent)</dt>
+<dd>
+reference to the close event
+</dd>
+</dl>
 <a NAME="CyclomaticComplexityDialog.cyclomaticComplexity" ID="CyclomaticComplexityDialog.cyclomaticComplexity"></a>
 <h4>CyclomaticComplexityDialog.cyclomaticComplexity</h4>
-<b>cyclomaticComplexity</b>(<i>codestring=""</i>)
+<b>cyclomaticComplexity</b>(<i></i>)
 
 <p>
         Public method to start a cyclomatic complexity calculation for one
@@ -346,13 +375,6 @@
 <p>
         The results are reported to the __processResult slot.
 </p>
-<dl>
-
-<dt><i>codestring</i> (str)</dt>
-<dd>
-optional sourcestring
-</dd>
-</dl>
 <a NAME="CyclomaticComplexityDialog.cyclomaticComplexityBatch" ID="CyclomaticComplexityDialog.cyclomaticComplexityBatch"></a>
 <h4>CyclomaticComplexityDialog.cyclomaticComplexityBatch</h4>
 <b>cyclomaticComplexityBatch</b>(<i></i>)
@@ -379,16 +401,16 @@
 </dl>
 <a NAME="CyclomaticComplexityDialog.on_rankComboBox_activated" ID="CyclomaticComplexityDialog.on_rankComboBox_activated"></a>
 <h4>CyclomaticComplexityDialog.on_rankComboBox_activated</h4>
-<b>on_rankComboBox_activated</b>(<i>rank</i>)
+<b>on_rankComboBox_activated</b>(<i>index</i>)
 
 <p>
         Private slot to handle the selection of a minimum rank.
 </p>
 <dl>
 
-<dt><i>rank</i> (str)</dt>
+<dt><i>index</i> (str)</dt>
 <dd>
-selected minimum rank
+index of the selected minimum rank
 </dd>
 </dl>
 <a NAME="CyclomaticComplexityDialog.on_resultList_itemActivated" ID="CyclomaticComplexityDialog.on_resultList_itemActivated"></a>
@@ -436,7 +458,7 @@
 </dl>
 <a NAME="CyclomaticComplexityDialog.start" ID="CyclomaticComplexityDialog.start"></a>
 <h4>CyclomaticComplexityDialog.start</h4>
-<b>start</b>(<i>fn, minRank="D"</i>)
+<b>start</b>(<i>fn</i>)
 
 <p>
         Public slot to start the cyclomatic complexity determination.
@@ -448,10 +470,6 @@
 file or list of files or directory to show
             the cyclomatic complexity for
 </dd>
-<dt><i>minRank</i> (str (one character out of A - F))</dt>
-<dd>
-minimum rank of entries to be shown
-</dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />