RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CyclomaticComplexityDialog.html

branch
eric7
changeset 107
0843dd7239f6
parent 95
e2e82819eec0
child 111
897c71cbc967
equal deleted inserted replaced
106:6422943b388f 107:0843dd7239f6
63 <tr> 63 <tr>
64 <td><a href="#CyclomaticComplexityDialog.__batchFinished">__batchFinished</a></td> 64 <td><a href="#CyclomaticComplexityDialog.__batchFinished">__batchFinished</a></td>
65 <td>Private slot handling the completion of a batch job.</td> 65 <td>Private slot handling the completion of a batch job.</td>
66 </tr> 66 </tr>
67 <tr> 67 <tr>
68 <td><a href="#CyclomaticComplexityDialog.__cancel">__cancel</a></td>
69 <td>Private method to cancel the current check run.</td>
70 </tr>
71 <tr>
68 <td><a href="#CyclomaticComplexityDialog.__createErrorItem">__createErrorItem</a></td> 72 <td><a href="#CyclomaticComplexityDialog.__createErrorItem">__createErrorItem</a></td>
69 <td>Private slot to create a new error item in the result list.</td> 73 <td>Private slot to create a new error item in the result list.</td>
70 </tr> 74 </tr>
71 <tr> 75 <tr>
72 <td><a href="#CyclomaticComplexityDialog.__createFileItem">__createFileItem</a></td> 76 <td><a href="#CyclomaticComplexityDialog.__createFileItem">__createFileItem</a></td>
105 <td>Private slot to show the context menu of the resultlist.</td> 109 <td>Private slot to show the context menu of the resultlist.</td>
106 </tr> 110 </tr>
107 <tr> 111 <tr>
108 <td><a href="#CyclomaticComplexityDialog.clear">clear</a></td> 112 <td><a href="#CyclomaticComplexityDialog.clear">clear</a></td>
109 <td>Public method to clear all results.</td> 113 <td>Public method to clear all results.</td>
114 </tr>
115 <tr>
116 <td><a href="#CyclomaticComplexityDialog.closeEvent">closeEvent</a></td>
117 <td>Protected method to handle a close event.</td>
110 </tr> 118 </tr>
111 <tr> 119 <tr>
112 <td><a href="#CyclomaticComplexityDialog.cyclomaticComplexity">cyclomaticComplexity</a></td> 120 <td><a href="#CyclomaticComplexityDialog.cyclomaticComplexity">cyclomaticComplexity</a></td>
113 <td>Public method to start a cyclomatic complexity calculation for one Python file.</td> 121 <td>Public method to start a cyclomatic complexity calculation for one Python file.</td>
114 </tr> 122 </tr>
181 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> 189 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt>
182 <dd> 190 <dd>
183 type of the calculated metrics 191 type of the calculated metrics
184 </dd> 192 </dd>
185 </dl> 193 </dl>
194 <a NAME="CyclomaticComplexityDialog.__cancel" ID="CyclomaticComplexityDialog.__cancel"></a>
195 <h4>CyclomaticComplexityDialog.__cancel</h4>
196 <b>__cancel</b>(<i></i>)
197
198 <p>
199 Private method to cancel the current check run.
200 </p>
186 <a NAME="CyclomaticComplexityDialog.__createErrorItem" ID="CyclomaticComplexityDialog.__createErrorItem"></a> 201 <a NAME="CyclomaticComplexityDialog.__createErrorItem" ID="CyclomaticComplexityDialog.__createErrorItem"></a>
187 <h4>CyclomaticComplexityDialog.__createErrorItem</h4> 202 <h4>CyclomaticComplexityDialog.__createErrorItem</h4>
188 <b>__createErrorItem</b>(<i>filename, message</i>) 203 <b>__createErrorItem</b>(<i>filename, message</i>)
189 204
190 <p> 205 <p>
333 <b>clear</b>(<i></i>) 348 <b>clear</b>(<i></i>)
334 349
335 <p> 350 <p>
336 Public method to clear all results. 351 Public method to clear all results.
337 </p> 352 </p>
353 <a NAME="CyclomaticComplexityDialog.closeEvent" ID="CyclomaticComplexityDialog.closeEvent"></a>
354 <h4>CyclomaticComplexityDialog.closeEvent</h4>
355 <b>closeEvent</b>(<i>evt</i>)
356
357 <p>
358 Protected method to handle a close event.
359 </p>
360 <dl>
361
362 <dt><i>evt</i> (QCloseEvent)</dt>
363 <dd>
364 reference to the close event
365 </dd>
366 </dl>
338 <a NAME="CyclomaticComplexityDialog.cyclomaticComplexity" ID="CyclomaticComplexityDialog.cyclomaticComplexity"></a> 367 <a NAME="CyclomaticComplexityDialog.cyclomaticComplexity" ID="CyclomaticComplexityDialog.cyclomaticComplexity"></a>
339 <h4>CyclomaticComplexityDialog.cyclomaticComplexity</h4> 368 <h4>CyclomaticComplexityDialog.cyclomaticComplexity</h4>
340 <b>cyclomaticComplexity</b>(<i>codestring=""</i>) 369 <b>cyclomaticComplexity</b>(<i></i>)
341 370
342 <p> 371 <p>
343 Public method to start a cyclomatic complexity calculation for one 372 Public method to start a cyclomatic complexity calculation for one
344 Python file. 373 Python file.
345 </p> 374 </p>
346 <p> 375 <p>
347 The results are reported to the __processResult slot. 376 The results are reported to the __processResult slot.
348 </p> 377 </p>
349 <dl>
350
351 <dt><i>codestring</i> (str)</dt>
352 <dd>
353 optional sourcestring
354 </dd>
355 </dl>
356 <a NAME="CyclomaticComplexityDialog.cyclomaticComplexityBatch" ID="CyclomaticComplexityDialog.cyclomaticComplexityBatch"></a> 378 <a NAME="CyclomaticComplexityDialog.cyclomaticComplexityBatch" ID="CyclomaticComplexityDialog.cyclomaticComplexityBatch"></a>
357 <h4>CyclomaticComplexityDialog.cyclomaticComplexityBatch</h4> 379 <h4>CyclomaticComplexityDialog.cyclomaticComplexityBatch</h4>
358 <b>cyclomaticComplexityBatch</b>(<i></i>) 380 <b>cyclomaticComplexityBatch</b>(<i></i>)
359 381
360 <p> 382 <p>
377 button that was clicked 399 button that was clicked
378 </dd> 400 </dd>
379 </dl> 401 </dl>
380 <a NAME="CyclomaticComplexityDialog.on_rankComboBox_activated" ID="CyclomaticComplexityDialog.on_rankComboBox_activated"></a> 402 <a NAME="CyclomaticComplexityDialog.on_rankComboBox_activated" ID="CyclomaticComplexityDialog.on_rankComboBox_activated"></a>
381 <h4>CyclomaticComplexityDialog.on_rankComboBox_activated</h4> 403 <h4>CyclomaticComplexityDialog.on_rankComboBox_activated</h4>
382 <b>on_rankComboBox_activated</b>(<i>rank</i>) 404 <b>on_rankComboBox_activated</b>(<i>index</i>)
383 405
384 <p> 406 <p>
385 Private slot to handle the selection of a minimum rank. 407 Private slot to handle the selection of a minimum rank.
386 </p> 408 </p>
387 <dl> 409 <dl>
388 410
389 <dt><i>rank</i> (str)</dt> 411 <dt><i>index</i> (str)</dt>
390 <dd> 412 <dd>
391 selected minimum rank 413 index of the selected minimum rank
392 </dd> 414 </dd>
393 </dl> 415 </dl>
394 <a NAME="CyclomaticComplexityDialog.on_resultList_itemActivated" ID="CyclomaticComplexityDialog.on_resultList_itemActivated"></a> 416 <a NAME="CyclomaticComplexityDialog.on_resultList_itemActivated" ID="CyclomaticComplexityDialog.on_resultList_itemActivated"></a>
395 <h4>CyclomaticComplexityDialog.on_resultList_itemActivated</h4> 417 <h4>CyclomaticComplexityDialog.on_resultList_itemActivated</h4>
396 <b>on_resultList_itemActivated</b>(<i>item, column</i>) 418 <b>on_resultList_itemActivated</b>(<i>item, column</i>)
434 reference to the project object 456 reference to the project object
435 </dd> 457 </dd>
436 </dl> 458 </dl>
437 <a NAME="CyclomaticComplexityDialog.start" ID="CyclomaticComplexityDialog.start"></a> 459 <a NAME="CyclomaticComplexityDialog.start" ID="CyclomaticComplexityDialog.start"></a>
438 <h4>CyclomaticComplexityDialog.start</h4> 460 <h4>CyclomaticComplexityDialog.start</h4>
439 <b>start</b>(<i>fn, minRank="D"</i>) 461 <b>start</b>(<i>fn</i>)
440 462
441 <p> 463 <p>
442 Public slot to start the cyclomatic complexity determination. 464 Public slot to start the cyclomatic complexity determination.
443 </p> 465 </p>
444 <dl> 466 <dl>
445 467
446 <dt><i>fn</i> (str or list of str)</dt> 468 <dt><i>fn</i> (str or list of str)</dt>
447 <dd> 469 <dd>
448 file or list of files or directory to show 470 file or list of files or directory to show
449 the cyclomatic complexity for 471 the cyclomatic complexity for
450 </dd>
451 <dt><i>minRank</i> (str (one character out of A - F))</dt>
452 <dd>
453 minimum rank of entries to be shown
454 </dd> 472 </dd>
455 </dl> 473 </dl>
456 <div align="right"><a href="#top">Up</a></div> 474 <div align="right"><a href="#top">Up</a></div>
457 <hr /> 475 <hr />
458 </body></html> 476 </body></html>

eric ide

mercurial