Mercurial Repositories > Radon Code Metrics / file comparison
comparison: RadonMetrics/Documentation/source/Plugin_Metrics_Radon.PluginMetricsRadon.html
RadonMetrics/Documentation/source/Plugin_Metrics_Radon.PluginMetricsRadon.html
- changeset 69
- cdf51e6abaee
- parent 55
- 755bc8e1485a
- child 78
- 4ce16e1d29f3
equal
deleted
inserted
replaced
| 68:69445de59a30 | 69:cdf51e6abaee |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Metrics_Radon.PluginMetricsRadon</h1> | 23 <h1>Plugin_Metrics_Radon.PluginMetricsRadon</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the radon code metrics plug-in. | 26 Module implementing the radon code metrics plug-in. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> | 31 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#RadonMetricsPlugin">RadonMetricsPlugin</a></td> | 38 <td><a href="#RadonMetricsPlugin">RadonMetricsPlugin</a></td> |
| 34 <td>Class implementing the radon code metrics plug-in.</td> | 39 <td>Class implementing the radon code metrics plug-in.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 43 | |
| 38 <table> | 44 <table> |
| 39 <tr><td>None</td></tr> | 45 <tr><td>None</td></tr> |
| 40 </table> | 46 </table> |
| 41 <hr /><hr /> | 47 <hr /> |
| 48 <hr /> | |
| 42 <a NAME="RadonMetricsPlugin" ID="RadonMetricsPlugin"></a> | 49 <a NAME="RadonMetricsPlugin" ID="RadonMetricsPlugin"></a> |
| 43 <h2>RadonMetricsPlugin</h2> | 50 <h2>RadonMetricsPlugin</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing the radon code metrics plug-in. | 53 Class implementing the radon code metrics plug-in. |
| 46 </p><h3>Signals</h3> | 54 </p> |
| 47 <dl> | 55 <h3>Signals</h3> |
| 56 <dl> | |
| 57 | |
| 48 <dt>batchFinished(str)</dt> | 58 <dt>batchFinished(str)</dt> |
| 49 <dd> | 59 <dd> |
| 50 emitted when a code metrics batch is done | 60 emitted when a code metrics batch is done |
| 51 </dd><dt>complexityDone(str, dict)</dt> | 61 </dd> |
| 62 <dt>complexityDone(str, dict)</dt> | |
| 52 <dd> | 63 <dd> |
| 53 emitted when the | 64 emitted when the |
| 54 cyclomatic complexity was determined for a file | 65 cyclomatic complexity was determined for a file |
| 55 </dd><dt>error(str, str, str)</dt> | 66 </dd> |
| 67 <dt>error(str, str, str)</dt> | |
| 56 <dd> | 68 <dd> |
| 57 emitted in case of an error | 69 emitted in case of an error |
| 58 </dd><dt>maintainabilityIndexDone(str, dict)</dt> | 70 </dd> |
| 71 <dt>maintainabilityIndexDone(str, dict)</dt> | |
| 59 <dd> | 72 <dd> |
| 60 emitted when the | 73 emitted when the |
| 61 maintainability index was determined for a file | 74 maintainability index was determined for a file |
| 62 </dd><dt>metricsDone(str, dict)</dt> | 75 </dd> |
| 76 <dt>metricsDone(str, dict)</dt> | |
| 63 <dd> | 77 <dd> |
| 64 emitted when the code metrics were | 78 emitted when the code metrics were |
| 65 determined for a file | 79 determined for a file |
| 66 </dd> | 80 </dd> |
| 67 </dl> | 81 </dl> |
| 68 <h3>Derived from</h3> | 82 <h3>Derived from</h3> |
| 69 QObject | 83 QObject |
| 70 <h3>Class Attributes</h3> | 84 <h3>Class Attributes</h3> |
| 85 | |
| 71 <table> | 86 <table> |
| 72 <tr><td>None</td></tr> | 87 <tr><td>None</td></tr> |
| 73 </table> | 88 </table> |
| 74 <h3>Class Methods</h3> | 89 <h3>Class Methods</h3> |
| 90 | |
| 75 <table> | 91 <table> |
| 76 <tr><td>None</td></tr> | 92 <tr><td>None</td></tr> |
| 77 </table> | 93 </table> |
| 78 <h3>Methods</h3> | 94 <h3>Methods</h3> |
| 95 | |
| 79 <table> | 96 <table> |
| 97 | |
| 80 <tr> | 98 <tr> |
| 81 <td><a href="#RadonMetricsPlugin.__init__">RadonMetricsPlugin</a></td> | 99 <td><a href="#RadonMetricsPlugin.__init__">RadonMetricsPlugin</a></td> |
| 82 <td>Constructor</td> | 100 <td>Constructor</td> |
| 83 </tr><tr> | 101 </tr> |
| 102 <tr> | |
| 84 <td><a href="#RadonMetricsPlugin.__editorClosed">__editorClosed</a></td> | 103 <td><a href="#RadonMetricsPlugin.__editorClosed">__editorClosed</a></td> |
| 85 <td>Private slot called, when an editor was closed.</td> | 104 <td>Private slot called, when an editor was closed.</td> |
| 86 </tr><tr> | 105 </tr> |
| 106 <tr> | |
| 87 <td><a href="#RadonMetricsPlugin.__editorCyclomaticComplexity">__editorCyclomaticComplexity</a></td> | 107 <td><a href="#RadonMetricsPlugin.__editorCyclomaticComplexity">__editorCyclomaticComplexity</a></td> |
| 88 <td>Private slot to handle the cyclomatic complexity action of the editor show menu.</td> | 108 <td>Private slot to handle the cyclomatic complexity action of the editor show menu.</td> |
| 89 </tr><tr> | 109 </tr> |
| 110 <tr> | |
| 90 <td><a href="#RadonMetricsPlugin.__editorMaintainabilityIndex">__editorMaintainabilityIndex</a></td> | 111 <td><a href="#RadonMetricsPlugin.__editorMaintainabilityIndex">__editorMaintainabilityIndex</a></td> |
| 91 <td>Private slot to handle the maintainability index action of the editor show menu.</td> | 112 <td>Private slot to handle the maintainability index action of the editor show menu.</td> |
| 92 </tr><tr> | 113 </tr> |
| 114 <tr> | |
| 93 <td><a href="#RadonMetricsPlugin.__editorOpened">__editorOpened</a></td> | 115 <td><a href="#RadonMetricsPlugin.__editorOpened">__editorOpened</a></td> |
| 94 <td>Private slot called, when a new editor was opened.</td> | 116 <td>Private slot called, when a new editor was opened.</td> |
| 95 </tr><tr> | 117 </tr> |
| 118 <tr> | |
| 96 <td><a href="#RadonMetricsPlugin.__editorRawMetrics">__editorRawMetrics</a></td> | 119 <td><a href="#RadonMetricsPlugin.__editorRawMetrics">__editorRawMetrics</a></td> |
| 97 <td>Private slot to handle the raw code metrics action of the editor show menu.</td> | 120 <td>Private slot to handle the raw code metrics action of the editor show menu.</td> |
| 98 </tr><tr> | 121 </tr> |
| 122 <tr> | |
| 99 <td><a href="#RadonMetricsPlugin.__editorRenamed">__editorRenamed</a></td> | 123 <td><a href="#RadonMetricsPlugin.__editorRenamed">__editorRenamed</a></td> |
| 100 <td>Private slot called, when an editor was renamed.</td> | 124 <td>Private slot called, when an editor was renamed.</td> |
| 101 </tr><tr> | 125 </tr> |
| 126 <tr> | |
| 102 <td><a href="#RadonMetricsPlugin.__editorShowMenu">__editorShowMenu</a></td> | 127 <td><a href="#RadonMetricsPlugin.__editorShowMenu">__editorShowMenu</a></td> |
| 103 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td> | 128 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td> |
| 104 </tr><tr> | 129 </tr> |
| 130 <tr> | |
| 105 <td><a href="#RadonMetricsPlugin.__initialize">__initialize</a></td> | 131 <td><a href="#RadonMetricsPlugin.__initialize">__initialize</a></td> |
| 106 <td>Private slot to (re)initialize the plugin.</td> | 132 <td>Private slot to (re)initialize the plugin.</td> |
| 107 </tr><tr> | 133 </tr> |
| 134 <tr> | |
| 108 <td><a href="#RadonMetricsPlugin.__loadTranslator">__loadTranslator</a></td> | 135 <td><a href="#RadonMetricsPlugin.__loadTranslator">__loadTranslator</a></td> |
| 109 <td>Private method to load the translation file.</td> | 136 <td>Private method to load the translation file.</td> |
| 110 </tr><tr> | 137 </tr> |
| 138 <tr> | |
| 111 <td><a href="#RadonMetricsPlugin.__projectBrowserCyclomaticComplexity">__projectBrowserCyclomaticComplexity</a></td> | 139 <td><a href="#RadonMetricsPlugin.__projectBrowserCyclomaticComplexity">__projectBrowserCyclomaticComplexity</a></td> |
| 112 <td>Private method to handle the cyclomatic complexity context menu action of the project sources browser.</td> | 140 <td>Private method to handle the cyclomatic complexity context menu action of the project sources browser.</td> |
| 113 </tr><tr> | 141 </tr> |
| 142 <tr> | |
| 114 <td><a href="#RadonMetricsPlugin.__projectBrowserMaintainabilityIndex">__projectBrowserMaintainabilityIndex</a></td> | 143 <td><a href="#RadonMetricsPlugin.__projectBrowserMaintainabilityIndex">__projectBrowserMaintainabilityIndex</a></td> |
| 115 <td>Private method to handle the maintainability index context menu action of the project sources browser.</td> | 144 <td>Private method to handle the maintainability index context menu action of the project sources browser.</td> |
| 116 </tr><tr> | 145 </tr> |
| 146 <tr> | |
| 117 <td><a href="#RadonMetricsPlugin.__projectBrowserRawMetrics">__projectBrowserRawMetrics</a></td> | 147 <td><a href="#RadonMetricsPlugin.__projectBrowserRawMetrics">__projectBrowserRawMetrics</a></td> |
| 118 <td>Private method to handle the code metrics context menu action of the project sources browser.</td> | 148 <td>Private method to handle the code metrics context menu action of the project sources browser.</td> |
| 119 </tr><tr> | 149 </tr> |
| 150 <tr> | |
| 120 <td><a href="#RadonMetricsPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td> | 151 <td><a href="#RadonMetricsPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td> |
| 121 <td>Private slot called, when the the project browser context menu or a submenu is about to be shown.</td> | 152 <td>Private slot called, when the the project browser context menu or a submenu is about to be shown.</td> |
| 122 </tr><tr> | 153 </tr> |
| 154 <tr> | |
| 123 <td><a href="#RadonMetricsPlugin.__projectClosed">__projectClosed</a></td> | 155 <td><a href="#RadonMetricsPlugin.__projectClosed">__projectClosed</a></td> |
| 124 <td>Private slot to handle closing a project.</td> | 156 <td>Private slot to handle closing a project.</td> |
| 125 </tr><tr> | 157 </tr> |
| 158 <tr> | |
| 126 <td><a href="#RadonMetricsPlugin.__projectCyclomaticComplexity">__projectCyclomaticComplexity</a></td> | 159 <td><a href="#RadonMetricsPlugin.__projectCyclomaticComplexity">__projectCyclomaticComplexity</a></td> |
| 127 <td>Private slot used to calculate the cyclomatic complexity for the project.</td> | 160 <td>Private slot used to calculate the cyclomatic complexity for the project.</td> |
| 128 </tr><tr> | 161 </tr> |
| 162 <tr> | |
| 129 <td><a href="#RadonMetricsPlugin.__projectMaintainabilityIndex">__projectMaintainabilityIndex</a></td> | 163 <td><a href="#RadonMetricsPlugin.__projectMaintainabilityIndex">__projectMaintainabilityIndex</a></td> |
| 130 <td>Private slot used to calculate the maintainability indexes for the project.</td> | 164 <td>Private slot used to calculate the maintainability indexes for the project.</td> |
| 131 </tr><tr> | 165 </tr> |
| 166 <tr> | |
| 132 <td><a href="#RadonMetricsPlugin.__projectRawMetrics">__projectRawMetrics</a></td> | 167 <td><a href="#RadonMetricsPlugin.__projectRawMetrics">__projectRawMetrics</a></td> |
| 133 <td>Private slot used to calculate raw code metrics for the project.</td> | 168 <td>Private slot used to calculate raw code metrics for the project.</td> |
| 134 </tr><tr> | 169 </tr> |
| 170 <tr> | |
| 135 <td><a href="#RadonMetricsPlugin.__projectShowMenu">__projectShowMenu</a></td> | 171 <td><a href="#RadonMetricsPlugin.__projectShowMenu">__projectShowMenu</a></td> |
| 136 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td> | 172 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td> |
| 137 </tr><tr> | 173 </tr> |
| 174 <tr> | |
| 138 <td><a href="#RadonMetricsPlugin.__serviceError">__serviceError</a></td> | 175 <td><a href="#RadonMetricsPlugin.__serviceError">__serviceError</a></td> |
| 139 <td>Private slot handling service errors.</td> | 176 <td>Private slot handling service errors.</td> |
| 140 </tr><tr> | 177 </tr> |
| 178 <tr> | |
| 141 <td><a href="#RadonMetricsPlugin.__showRadonVersion">__showRadonVersion</a></td> | 179 <td><a href="#RadonMetricsPlugin.__showRadonVersion">__showRadonVersion</a></td> |
| 142 <td>Private slot to show the version number of the used radon library.</td> | 180 <td>Private slot to show the version number of the used radon library.</td> |
| 143 </tr><tr> | 181 </tr> |
| 182 <tr> | |
| 144 <td><a href="#RadonMetricsPlugin.activate">activate</a></td> | 183 <td><a href="#RadonMetricsPlugin.activate">activate</a></td> |
| 145 <td>Public method to activate this plug-in.</td> | 184 <td>Public method to activate this plug-in.</td> |
| 146 </tr><tr> | 185 </tr> |
| 186 <tr> | |
| 147 <td><a href="#RadonMetricsPlugin.batchJobDone">batchJobDone</a></td> | 187 <td><a href="#RadonMetricsPlugin.batchJobDone">batchJobDone</a></td> |
| 148 <td>Public slot handling the completion of a batch job.</td> | 188 <td>Public slot handling the completion of a batch job.</td> |
| 149 </tr><tr> | 189 </tr> |
| 190 <tr> | |
| 150 <td><a href="#RadonMetricsPlugin.cancelComplexityBatch">cancelComplexityBatch</a></td> | 191 <td><a href="#RadonMetricsPlugin.cancelComplexityBatch">cancelComplexityBatch</a></td> |
| 151 <td>Public method to cancel all batch jobs.</td> | 192 <td>Public method to cancel all batch jobs.</td> |
| 152 </tr><tr> | 193 </tr> |
| 194 <tr> | |
| 153 <td><a href="#RadonMetricsPlugin.cancelMaintainabilityIndexBatch">cancelMaintainabilityIndexBatch</a></td> | 195 <td><a href="#RadonMetricsPlugin.cancelMaintainabilityIndexBatch">cancelMaintainabilityIndexBatch</a></td> |
| 154 <td>Public method to cancel all batch jobs.</td> | 196 <td>Public method to cancel all batch jobs.</td> |
| 155 </tr><tr> | 197 </tr> |
| 198 <tr> | |
| 156 <td><a href="#RadonMetricsPlugin.cancelRawMetricsBatch">cancelRawMetricsBatch</a></td> | 199 <td><a href="#RadonMetricsPlugin.cancelRawMetricsBatch">cancelRawMetricsBatch</a></td> |
| 157 <td>Public method to cancel all batch jobs.</td> | 200 <td>Public method to cancel all batch jobs.</td> |
| 158 </tr><tr> | 201 </tr> |
| 202 <tr> | |
| 159 <td><a href="#RadonMetricsPlugin.cyclomaticComplexity">cyclomaticComplexity</a></td> | 203 <td><a href="#RadonMetricsPlugin.cyclomaticComplexity">cyclomaticComplexity</a></td> |
| 160 <td>Public method to prepare cyclomatic complexity calculation on one Python source file.</td> | 204 <td>Public method to prepare cyclomatic complexity calculation on one Python source file.</td> |
| 161 </tr><tr> | 205 </tr> |
| 206 <tr> | |
| 162 <td><a href="#RadonMetricsPlugin.cyclomaticComplexityBatch">cyclomaticComplexityBatch</a></td> | 207 <td><a href="#RadonMetricsPlugin.cyclomaticComplexityBatch">cyclomaticComplexityBatch</a></td> |
| 163 <td>Public method to prepare cyclomatic complexity calculation on multiple Python source files.</td> | 208 <td>Public method to prepare cyclomatic complexity calculation on multiple Python source files.</td> |
| 164 </tr><tr> | 209 </tr> |
| 210 <tr> | |
| 165 <td><a href="#RadonMetricsPlugin.deactivate">deactivate</a></td> | 211 <td><a href="#RadonMetricsPlugin.deactivate">deactivate</a></td> |
| 166 <td>Public method to deactivate this plug-in.</td> | 212 <td>Public method to deactivate this plug-in.</td> |
| 167 </tr><tr> | 213 </tr> |
| 214 <tr> | |
| 168 <td><a href="#RadonMetricsPlugin.maintainabilityIndex">maintainabilityIndex</a></td> | 215 <td><a href="#RadonMetricsPlugin.maintainabilityIndex">maintainabilityIndex</a></td> |
| 169 <td>Public method to prepare maintainability index calculation on one Python source file.</td> | 216 <td>Public method to prepare maintainability index calculation on one Python source file.</td> |
| 170 </tr><tr> | 217 </tr> |
| 218 <tr> | |
| 171 <td><a href="#RadonMetricsPlugin.maintainabilityIndexBatch">maintainabilityIndexBatch</a></td> | 219 <td><a href="#RadonMetricsPlugin.maintainabilityIndexBatch">maintainabilityIndexBatch</a></td> |
| 172 <td>Public method to prepare maintainability index calculation on multiple Python source files.</td> | 220 <td>Public method to prepare maintainability index calculation on multiple Python source files.</td> |
| 173 </tr><tr> | 221 </tr> |
| 222 <tr> | |
| 174 <td><a href="#RadonMetricsPlugin.metricsCalculationDone">metricsCalculationDone</a></td> | 223 <td><a href="#RadonMetricsPlugin.metricsCalculationDone">metricsCalculationDone</a></td> |
| 175 <td>Public slot to dispatch the result.</td> | 224 <td>Public slot to dispatch the result.</td> |
| 176 </tr><tr> | 225 </tr> |
| 226 <tr> | |
| 177 <td><a href="#RadonMetricsPlugin.rawMetrics">rawMetrics</a></td> | 227 <td><a href="#RadonMetricsPlugin.rawMetrics">rawMetrics</a></td> |
| 178 <td>Public method to prepare raw code metrics calculation on one Python source file.</td> | 228 <td>Public method to prepare raw code metrics calculation on one Python source file.</td> |
| 179 </tr><tr> | 229 </tr> |
| 230 <tr> | |
| 180 <td><a href="#RadonMetricsPlugin.rawMetricsBatch">rawMetricsBatch</a></td> | 231 <td><a href="#RadonMetricsPlugin.rawMetricsBatch">rawMetricsBatch</a></td> |
| 181 <td>Public method to prepare raw code metrics calculation on multiple Python source files.</td> | 232 <td>Public method to prepare raw code metrics calculation on multiple Python source files.</td> |
| 182 </tr><tr> | 233 </tr> |
| 183 <td><a href="#RadonMetricsPlugin.serviceErrorPy2">serviceErrorPy2</a></td> | 234 <tr> |
| 184 <td>Public slot handling service errors for Python 2.</td> | |
| 185 </tr><tr> | |
| 186 <td><a href="#RadonMetricsPlugin.serviceErrorPy3">serviceErrorPy3</a></td> | 235 <td><a href="#RadonMetricsPlugin.serviceErrorPy3">serviceErrorPy3</a></td> |
| 187 <td>Public slot handling service errors for Python 3.</td> | 236 <td>Public slot handling service errors for Python 3.</td> |
| 188 </tr> | 237 </tr> |
| 189 </table> | 238 </table> |
| 190 <h3>Static Methods</h3> | 239 <h3>Static Methods</h3> |
| 240 | |
| 191 <table> | 241 <table> |
| 192 <tr><td>None</td></tr> | 242 <tr><td>None</td></tr> |
| 193 </table> | 243 </table> |
| 244 | |
| 194 <a NAME="RadonMetricsPlugin.__init__" ID="RadonMetricsPlugin.__init__"></a> | 245 <a NAME="RadonMetricsPlugin.__init__" ID="RadonMetricsPlugin.__init__"></a> |
| 195 <h4>RadonMetricsPlugin (Constructor)</h4> | 246 <h4>RadonMetricsPlugin (Constructor)</h4> |
| 196 <b>RadonMetricsPlugin</b>(<i>ui</i>) | 247 <b>RadonMetricsPlugin</b>(<i>ui</i>) |
| 248 | |
| 197 <p> | 249 <p> |
| 198 Constructor | 250 Constructor |
| 199 </p><dl> | 251 </p> |
| 252 <dl> | |
| 253 | |
| 200 <dt><i>ui</i> (UI.UserInterface)</dt> | 254 <dt><i>ui</i> (UI.UserInterface)</dt> |
| 201 <dd> | 255 <dd> |
| 202 reference to the user interface object | 256 reference to the user interface object |
| 203 </dd> | 257 </dd> |
| 204 </dl><a NAME="RadonMetricsPlugin.__editorClosed" ID="RadonMetricsPlugin.__editorClosed"></a> | 258 </dl> |
| 259 <a NAME="RadonMetricsPlugin.__editorClosed" ID="RadonMetricsPlugin.__editorClosed"></a> | |
| 205 <h4>RadonMetricsPlugin.__editorClosed</h4> | 260 <h4>RadonMetricsPlugin.__editorClosed</h4> |
| 206 <b>__editorClosed</b>(<i>editor</i>) | 261 <b>__editorClosed</b>(<i>editor</i>) |
| 262 | |
| 207 <p> | 263 <p> |
| 208 Private slot called, when an editor was closed. | 264 Private slot called, when an editor was closed. |
| 209 </p><dl> | 265 </p> |
| 266 <dl> | |
| 267 | |
| 210 <dt><i>editor</i></dt> | 268 <dt><i>editor</i></dt> |
| 211 <dd> | 269 <dd> |
| 212 reference to the editor (QScintilla.Editor) | 270 reference to the editor (QScintilla.Editor) |
| 213 </dd> | 271 </dd> |
| 214 </dl><a NAME="RadonMetricsPlugin.__editorCyclomaticComplexity" ID="RadonMetricsPlugin.__editorCyclomaticComplexity"></a> | 272 </dl> |
| 273 <a NAME="RadonMetricsPlugin.__editorCyclomaticComplexity" ID="RadonMetricsPlugin.__editorCyclomaticComplexity"></a> | |
| 215 <h4>RadonMetricsPlugin.__editorCyclomaticComplexity</h4> | 274 <h4>RadonMetricsPlugin.__editorCyclomaticComplexity</h4> |
| 216 <b>__editorCyclomaticComplexity</b>(<i></i>) | 275 <b>__editorCyclomaticComplexity</b>(<i></i>) |
| 276 | |
| 217 <p> | 277 <p> |
| 218 Private slot to handle the cyclomatic complexity action of the editor | 278 Private slot to handle the cyclomatic complexity action of the editor |
| 219 show menu. | 279 show menu. |
| 220 </p><a NAME="RadonMetricsPlugin.__editorMaintainabilityIndex" ID="RadonMetricsPlugin.__editorMaintainabilityIndex"></a> | 280 </p> |
| 281 <a NAME="RadonMetricsPlugin.__editorMaintainabilityIndex" ID="RadonMetricsPlugin.__editorMaintainabilityIndex"></a> | |
| 221 <h4>RadonMetricsPlugin.__editorMaintainabilityIndex</h4> | 282 <h4>RadonMetricsPlugin.__editorMaintainabilityIndex</h4> |
| 222 <b>__editorMaintainabilityIndex</b>(<i></i>) | 283 <b>__editorMaintainabilityIndex</b>(<i></i>) |
| 284 | |
| 223 <p> | 285 <p> |
| 224 Private slot to handle the maintainability index action of the editor | 286 Private slot to handle the maintainability index action of the editor |
| 225 show menu. | 287 show menu. |
| 226 </p><a NAME="RadonMetricsPlugin.__editorOpened" ID="RadonMetricsPlugin.__editorOpened"></a> | 288 </p> |
| 289 <a NAME="RadonMetricsPlugin.__editorOpened" ID="RadonMetricsPlugin.__editorOpened"></a> | |
| 227 <h4>RadonMetricsPlugin.__editorOpened</h4> | 290 <h4>RadonMetricsPlugin.__editorOpened</h4> |
| 228 <b>__editorOpened</b>(<i>editor</i>) | 291 <b>__editorOpened</b>(<i>editor</i>) |
| 292 | |
| 229 <p> | 293 <p> |
| 230 Private slot called, when a new editor was opened. | 294 Private slot called, when a new editor was opened. |
| 231 </p><dl> | 295 </p> |
| 296 <dl> | |
| 297 | |
| 232 <dt><i>editor</i> (QScintilla.Editor)</dt> | 298 <dt><i>editor</i> (QScintilla.Editor)</dt> |
| 233 <dd> | 299 <dd> |
| 234 reference to the new editor | 300 reference to the new editor |
| 235 </dd> | 301 </dd> |
| 236 </dl><a NAME="RadonMetricsPlugin.__editorRawMetrics" ID="RadonMetricsPlugin.__editorRawMetrics"></a> | 302 </dl> |
| 303 <a NAME="RadonMetricsPlugin.__editorRawMetrics" ID="RadonMetricsPlugin.__editorRawMetrics"></a> | |
| 237 <h4>RadonMetricsPlugin.__editorRawMetrics</h4> | 304 <h4>RadonMetricsPlugin.__editorRawMetrics</h4> |
| 238 <b>__editorRawMetrics</b>(<i></i>) | 305 <b>__editorRawMetrics</b>(<i></i>) |
| 306 | |
| 239 <p> | 307 <p> |
| 240 Private slot to handle the raw code metrics action of the editor show | 308 Private slot to handle the raw code metrics action of the editor show |
| 241 menu. | 309 menu. |
| 242 </p><a NAME="RadonMetricsPlugin.__editorRenamed" ID="RadonMetricsPlugin.__editorRenamed"></a> | 310 </p> |
| 311 <a NAME="RadonMetricsPlugin.__editorRenamed" ID="RadonMetricsPlugin.__editorRenamed"></a> | |
| 243 <h4>RadonMetricsPlugin.__editorRenamed</h4> | 312 <h4>RadonMetricsPlugin.__editorRenamed</h4> |
| 244 <b>__editorRenamed</b>(<i>editor</i>) | 313 <b>__editorRenamed</b>(<i>editor</i>) |
| 314 | |
| 245 <p> | 315 <p> |
| 246 Private slot called, when an editor was renamed. | 316 Private slot called, when an editor was renamed. |
| 247 </p><dl> | 317 </p> |
| 318 <dl> | |
| 319 | |
| 248 <dt><i>editor</i> (QScintilla.Editor)</dt> | 320 <dt><i>editor</i> (QScintilla.Editor)</dt> |
| 249 <dd> | 321 <dd> |
| 250 reference to the renamed editor | 322 reference to the renamed editor |
| 251 </dd> | 323 </dd> |
| 252 </dl><a NAME="RadonMetricsPlugin.__editorShowMenu" ID="RadonMetricsPlugin.__editorShowMenu"></a> | 324 </dl> |
| 325 <a NAME="RadonMetricsPlugin.__editorShowMenu" ID="RadonMetricsPlugin.__editorShowMenu"></a> | |
| 253 <h4>RadonMetricsPlugin.__editorShowMenu</h4> | 326 <h4>RadonMetricsPlugin.__editorShowMenu</h4> |
| 254 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) | 327 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) |
| 328 | |
| 255 <p> | 329 <p> |
| 256 Private slot called, when the the editor context menu or a submenu is | 330 Private slot called, when the the editor context menu or a submenu is |
| 257 about to be shown. | 331 about to be shown. |
| 258 </p><dl> | 332 </p> |
| 333 <dl> | |
| 334 | |
| 259 <dt><i>menuName</i></dt> | 335 <dt><i>menuName</i></dt> |
| 260 <dd> | 336 <dd> |
| 261 name of the menu to be shown (string) | 337 name of the menu to be shown (string) |
| 262 </dd><dt><i>menu</i></dt> | 338 </dd> |
| 339 <dt><i>menu</i></dt> | |
| 263 <dd> | 340 <dd> |
| 264 reference to the menu (QMenu) | 341 reference to the menu (QMenu) |
| 265 </dd><dt><i>editor</i></dt> | 342 </dd> |
| 343 <dt><i>editor</i></dt> | |
| 266 <dd> | 344 <dd> |
| 267 reference to the editor | 345 reference to the editor |
| 268 </dd> | 346 </dd> |
| 269 </dl><a NAME="RadonMetricsPlugin.__initialize" ID="RadonMetricsPlugin.__initialize"></a> | 347 </dl> |
| 348 <a NAME="RadonMetricsPlugin.__initialize" ID="RadonMetricsPlugin.__initialize"></a> | |
| 270 <h4>RadonMetricsPlugin.__initialize</h4> | 349 <h4>RadonMetricsPlugin.__initialize</h4> |
| 271 <b>__initialize</b>(<i></i>) | 350 <b>__initialize</b>(<i></i>) |
| 351 | |
| 272 <p> | 352 <p> |
| 273 Private slot to (re)initialize the plugin. | 353 Private slot to (re)initialize the plugin. |
| 274 </p><a NAME="RadonMetricsPlugin.__loadTranslator" ID="RadonMetricsPlugin.__loadTranslator"></a> | 354 </p> |
| 355 <a NAME="RadonMetricsPlugin.__loadTranslator" ID="RadonMetricsPlugin.__loadTranslator"></a> | |
| 275 <h4>RadonMetricsPlugin.__loadTranslator</h4> | 356 <h4>RadonMetricsPlugin.__loadTranslator</h4> |
| 276 <b>__loadTranslator</b>(<i></i>) | 357 <b>__loadTranslator</b>(<i></i>) |
| 358 | |
| 277 <p> | 359 <p> |
| 278 Private method to load the translation file. | 360 Private method to load the translation file. |
| 279 </p><a NAME="RadonMetricsPlugin.__projectBrowserCyclomaticComplexity" ID="RadonMetricsPlugin.__projectBrowserCyclomaticComplexity"></a> | 361 </p> |
| 362 <a NAME="RadonMetricsPlugin.__projectBrowserCyclomaticComplexity" ID="RadonMetricsPlugin.__projectBrowserCyclomaticComplexity"></a> | |
| 280 <h4>RadonMetricsPlugin.__projectBrowserCyclomaticComplexity</h4> | 363 <h4>RadonMetricsPlugin.__projectBrowserCyclomaticComplexity</h4> |
| 281 <b>__projectBrowserCyclomaticComplexity</b>(<i></i>) | 364 <b>__projectBrowserCyclomaticComplexity</b>(<i></i>) |
| 365 | |
| 282 <p> | 366 <p> |
| 283 Private method to handle the cyclomatic complexity context menu action | 367 Private method to handle the cyclomatic complexity context menu action |
| 284 of the project sources browser. | 368 of the project sources browser. |
| 285 </p><a NAME="RadonMetricsPlugin.__projectBrowserMaintainabilityIndex" ID="RadonMetricsPlugin.__projectBrowserMaintainabilityIndex"></a> | 369 </p> |
| 370 <a NAME="RadonMetricsPlugin.__projectBrowserMaintainabilityIndex" ID="RadonMetricsPlugin.__projectBrowserMaintainabilityIndex"></a> | |
| 286 <h4>RadonMetricsPlugin.__projectBrowserMaintainabilityIndex</h4> | 371 <h4>RadonMetricsPlugin.__projectBrowserMaintainabilityIndex</h4> |
| 287 <b>__projectBrowserMaintainabilityIndex</b>(<i></i>) | 372 <b>__projectBrowserMaintainabilityIndex</b>(<i></i>) |
| 373 | |
| 288 <p> | 374 <p> |
| 289 Private method to handle the maintainability index context menu action | 375 Private method to handle the maintainability index context menu action |
| 290 of the project sources browser. | 376 of the project sources browser. |
| 291 </p><a NAME="RadonMetricsPlugin.__projectBrowserRawMetrics" ID="RadonMetricsPlugin.__projectBrowserRawMetrics"></a> | 377 </p> |
| 378 <a NAME="RadonMetricsPlugin.__projectBrowserRawMetrics" ID="RadonMetricsPlugin.__projectBrowserRawMetrics"></a> | |
| 292 <h4>RadonMetricsPlugin.__projectBrowserRawMetrics</h4> | 379 <h4>RadonMetricsPlugin.__projectBrowserRawMetrics</h4> |
| 293 <b>__projectBrowserRawMetrics</b>(<i></i>) | 380 <b>__projectBrowserRawMetrics</b>(<i></i>) |
| 381 | |
| 294 <p> | 382 <p> |
| 295 Private method to handle the code metrics context menu action of the | 383 Private method to handle the code metrics context menu action of the |
| 296 project sources browser. | 384 project sources browser. |
| 297 </p><a NAME="RadonMetricsPlugin.__projectBrowserShowMenu" ID="RadonMetricsPlugin.__projectBrowserShowMenu"></a> | 385 </p> |
| 386 <a NAME="RadonMetricsPlugin.__projectBrowserShowMenu" ID="RadonMetricsPlugin.__projectBrowserShowMenu"></a> | |
| 298 <h4>RadonMetricsPlugin.__projectBrowserShowMenu</h4> | 387 <h4>RadonMetricsPlugin.__projectBrowserShowMenu</h4> |
| 299 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>) | 388 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>) |
| 389 | |
| 300 <p> | 390 <p> |
| 301 Private slot called, when the the project browser context menu or a | 391 Private slot called, when the the project browser context menu or a |
| 302 submenu is about to be shown. | 392 submenu is about to be shown. |
| 303 </p><dl> | 393 </p> |
| 394 <dl> | |
| 395 | |
| 304 <dt><i>menuName</i></dt> | 396 <dt><i>menuName</i></dt> |
| 305 <dd> | 397 <dd> |
| 306 name of the menu to be shown (string) | 398 name of the menu to be shown (string) |
| 307 </dd><dt><i>menu</i></dt> | 399 </dd> |
| 400 <dt><i>menu</i></dt> | |
| 308 <dd> | 401 <dd> |
| 309 reference to the menu (QMenu) | 402 reference to the menu (QMenu) |
| 310 </dd> | 403 </dd> |
| 311 </dl><a NAME="RadonMetricsPlugin.__projectClosed" ID="RadonMetricsPlugin.__projectClosed"></a> | 404 </dl> |
| 405 <a NAME="RadonMetricsPlugin.__projectClosed" ID="RadonMetricsPlugin.__projectClosed"></a> | |
| 312 <h4>RadonMetricsPlugin.__projectClosed</h4> | 406 <h4>RadonMetricsPlugin.__projectClosed</h4> |
| 313 <b>__projectClosed</b>(<i></i>) | 407 <b>__projectClosed</b>(<i></i>) |
| 408 | |
| 314 <p> | 409 <p> |
| 315 Private slot to handle closing a project. | 410 Private slot to handle closing a project. |
| 316 </p><a NAME="RadonMetricsPlugin.__projectCyclomaticComplexity" ID="RadonMetricsPlugin.__projectCyclomaticComplexity"></a> | 411 </p> |
| 412 <a NAME="RadonMetricsPlugin.__projectCyclomaticComplexity" ID="RadonMetricsPlugin.__projectCyclomaticComplexity"></a> | |
| 317 <h4>RadonMetricsPlugin.__projectCyclomaticComplexity</h4> | 413 <h4>RadonMetricsPlugin.__projectCyclomaticComplexity</h4> |
| 318 <b>__projectCyclomaticComplexity</b>(<i></i>) | 414 <b>__projectCyclomaticComplexity</b>(<i></i>) |
| 415 | |
| 319 <p> | 416 <p> |
| 320 Private slot used to calculate the cyclomatic complexity for the | 417 Private slot used to calculate the cyclomatic complexity for the |
| 321 project. | 418 project. |
| 322 </p><a NAME="RadonMetricsPlugin.__projectMaintainabilityIndex" ID="RadonMetricsPlugin.__projectMaintainabilityIndex"></a> | 419 </p> |
| 420 <a NAME="RadonMetricsPlugin.__projectMaintainabilityIndex" ID="RadonMetricsPlugin.__projectMaintainabilityIndex"></a> | |
| 323 <h4>RadonMetricsPlugin.__projectMaintainabilityIndex</h4> | 421 <h4>RadonMetricsPlugin.__projectMaintainabilityIndex</h4> |
| 324 <b>__projectMaintainabilityIndex</b>(<i></i>) | 422 <b>__projectMaintainabilityIndex</b>(<i></i>) |
| 423 | |
| 325 <p> | 424 <p> |
| 326 Private slot used to calculate the maintainability indexes for the | 425 Private slot used to calculate the maintainability indexes for the |
| 327 project. | 426 project. |
| 328 </p><a NAME="RadonMetricsPlugin.__projectRawMetrics" ID="RadonMetricsPlugin.__projectRawMetrics"></a> | 427 </p> |
| 428 <a NAME="RadonMetricsPlugin.__projectRawMetrics" ID="RadonMetricsPlugin.__projectRawMetrics"></a> | |
| 329 <h4>RadonMetricsPlugin.__projectRawMetrics</h4> | 429 <h4>RadonMetricsPlugin.__projectRawMetrics</h4> |
| 330 <b>__projectRawMetrics</b>(<i></i>) | 430 <b>__projectRawMetrics</b>(<i></i>) |
| 431 | |
| 331 <p> | 432 <p> |
| 332 Private slot used to calculate raw code metrics for the project. | 433 Private slot used to calculate raw code metrics for the project. |
| 333 </p><a NAME="RadonMetricsPlugin.__projectShowMenu" ID="RadonMetricsPlugin.__projectShowMenu"></a> | 434 </p> |
| 435 <a NAME="RadonMetricsPlugin.__projectShowMenu" ID="RadonMetricsPlugin.__projectShowMenu"></a> | |
| 334 <h4>RadonMetricsPlugin.__projectShowMenu</h4> | 436 <h4>RadonMetricsPlugin.__projectShowMenu</h4> |
| 335 <b>__projectShowMenu</b>(<i>menuName, menu</i>) | 437 <b>__projectShowMenu</b>(<i>menuName, menu</i>) |
| 438 | |
| 336 <p> | 439 <p> |
| 337 Private slot called, when the the project menu or a submenu is | 440 Private slot called, when the the project menu or a submenu is |
| 338 about to be shown. | 441 about to be shown. |
| 339 </p><dl> | 442 </p> |
| 443 <dl> | |
| 444 | |
| 340 <dt><i>menuName</i> (str)</dt> | 445 <dt><i>menuName</i> (str)</dt> |
| 341 <dd> | 446 <dd> |
| 342 name of the menu to be shown | 447 name of the menu to be shown |
| 343 </dd><dt><i>menu</i> (QMenu)</dt> | 448 </dd> |
| 449 <dt><i>menu</i> (QMenu)</dt> | |
| 344 <dd> | 450 <dd> |
| 345 reference to the menu | 451 reference to the menu |
| 346 </dd> | 452 </dd> |
| 347 </dl><a NAME="RadonMetricsPlugin.__serviceError" ID="RadonMetricsPlugin.__serviceError"></a> | 453 </dl> |
| 454 <a NAME="RadonMetricsPlugin.__serviceError" ID="RadonMetricsPlugin.__serviceError"></a> | |
| 348 <h4>RadonMetricsPlugin.__serviceError</h4> | 455 <h4>RadonMetricsPlugin.__serviceError</h4> |
| 349 <b>__serviceError</b>(<i>type_, fn, msg</i>) | 456 <b>__serviceError</b>(<i>type_, fn, msg</i>) |
| 457 | |
| 350 <p> | 458 <p> |
| 351 Private slot handling service errors. | 459 Private slot handling service errors. |
| 352 </p><dl> | 460 </p> |
| 461 <dl> | |
| 462 | |
| 353 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> | 463 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> |
| 354 <dd> | 464 <dd> |
| 355 type of the calculated metrics | 465 type of the calculated metrics |
| 356 </dd><dt><i>fn</i> (str)</dt> | 466 </dd> |
| 467 <dt><i>fn</i> (str)</dt> | |
| 357 <dd> | 468 <dd> |
| 358 file name | 469 file name |
| 359 </dd><dt><i>msg</i> (str)</dt> | 470 </dd> |
| 471 <dt><i>msg</i> (str)</dt> | |
| 360 <dd> | 472 <dd> |
| 361 message text | 473 message text |
| 362 </dd> | 474 </dd> |
| 363 </dl><a NAME="RadonMetricsPlugin.__showRadonVersion" ID="RadonMetricsPlugin.__showRadonVersion"></a> | 475 </dl> |
| 476 <a NAME="RadonMetricsPlugin.__showRadonVersion" ID="RadonMetricsPlugin.__showRadonVersion"></a> | |
| 364 <h4>RadonMetricsPlugin.__showRadonVersion</h4> | 477 <h4>RadonMetricsPlugin.__showRadonVersion</h4> |
| 365 <b>__showRadonVersion</b>(<i></i>) | 478 <b>__showRadonVersion</b>(<i></i>) |
| 479 | |
| 366 <p> | 480 <p> |
| 367 Private slot to show the version number of the used radon library. | 481 Private slot to show the version number of the used radon library. |
| 368 </p><a NAME="RadonMetricsPlugin.activate" ID="RadonMetricsPlugin.activate"></a> | 482 </p> |
| 483 <a NAME="RadonMetricsPlugin.activate" ID="RadonMetricsPlugin.activate"></a> | |
| 369 <h4>RadonMetricsPlugin.activate</h4> | 484 <h4>RadonMetricsPlugin.activate</h4> |
| 370 <b>activate</b>(<i></i>) | 485 <b>activate</b>(<i></i>) |
| 486 | |
| 371 <p> | 487 <p> |
| 372 Public method to activate this plug-in. | 488 Public method to activate this plug-in. |
| 373 </p><dl> | 489 </p> |
| 490 <dl> | |
| 374 <dt>Returns:</dt> | 491 <dt>Returns:</dt> |
| 375 <dd> | 492 <dd> |
| 376 tuple of None and activation status | 493 tuple of None and activation status |
| 377 </dd> | 494 </dd> |
| 378 </dl><dl> | 495 </dl> |
| 496 <dl> | |
| 379 <dt>Return Type:</dt> | 497 <dt>Return Type:</dt> |
| 380 <dd> | 498 <dd> |
| 381 (None, bool) | 499 (None, bool) |
| 382 </dd> | 500 </dd> |
| 383 </dl><a NAME="RadonMetricsPlugin.batchJobDone" ID="RadonMetricsPlugin.batchJobDone"></a> | 501 </dl> |
| 502 <a NAME="RadonMetricsPlugin.batchJobDone" ID="RadonMetricsPlugin.batchJobDone"></a> | |
| 384 <h4>RadonMetricsPlugin.batchJobDone</h4> | 503 <h4>RadonMetricsPlugin.batchJobDone</h4> |
| 385 <b>batchJobDone</b>(<i>type_, fx, lang</i>) | 504 <b>batchJobDone</b>(<i>type_, fx, lang</i>) |
| 505 | |
| 386 <p> | 506 <p> |
| 387 Public slot handling the completion of a batch job. | 507 Public slot handling the completion of a batch job. |
| 388 </p><dl> | 508 </p> |
| 509 <dl> | |
| 510 | |
| 389 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> | 511 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> |
| 390 <dd> | 512 <dd> |
| 391 type of the calculated metrics | 513 type of the calculated metrics |
| 392 </dd><dt><i>fx</i> (str)</dt> | 514 </dd> |
| 515 <dt><i>fx</i> (str)</dt> | |
| 393 <dd> | 516 <dd> |
| 394 service name | 517 service name |
| 395 </dd><dt><i>lang</i> (str)</dt> | 518 </dd> |
| 519 <dt><i>lang</i> (str)</dt> | |
| 396 <dd> | 520 <dd> |
| 397 language | 521 language |
| 398 </dd> | 522 </dd> |
| 399 </dl><a NAME="RadonMetricsPlugin.cancelComplexityBatch" ID="RadonMetricsPlugin.cancelComplexityBatch"></a> | 523 </dl> |
| 524 <a NAME="RadonMetricsPlugin.cancelComplexityBatch" ID="RadonMetricsPlugin.cancelComplexityBatch"></a> | |
| 400 <h4>RadonMetricsPlugin.cancelComplexityBatch</h4> | 525 <h4>RadonMetricsPlugin.cancelComplexityBatch</h4> |
| 401 <b>cancelComplexityBatch</b>(<i></i>) | 526 <b>cancelComplexityBatch</b>(<i></i>) |
| 527 | |
| 402 <p> | 528 <p> |
| 403 Public method to cancel all batch jobs. | 529 Public method to cancel all batch jobs. |
| 404 </p><a NAME="RadonMetricsPlugin.cancelMaintainabilityIndexBatch" ID="RadonMetricsPlugin.cancelMaintainabilityIndexBatch"></a> | 530 </p> |
| 531 <a NAME="RadonMetricsPlugin.cancelMaintainabilityIndexBatch" ID="RadonMetricsPlugin.cancelMaintainabilityIndexBatch"></a> | |
| 405 <h4>RadonMetricsPlugin.cancelMaintainabilityIndexBatch</h4> | 532 <h4>RadonMetricsPlugin.cancelMaintainabilityIndexBatch</h4> |
| 406 <b>cancelMaintainabilityIndexBatch</b>(<i></i>) | 533 <b>cancelMaintainabilityIndexBatch</b>(<i></i>) |
| 534 | |
| 407 <p> | 535 <p> |
| 408 Public method to cancel all batch jobs. | 536 Public method to cancel all batch jobs. |
| 409 </p><a NAME="RadonMetricsPlugin.cancelRawMetricsBatch" ID="RadonMetricsPlugin.cancelRawMetricsBatch"></a> | 537 </p> |
| 538 <a NAME="RadonMetricsPlugin.cancelRawMetricsBatch" ID="RadonMetricsPlugin.cancelRawMetricsBatch"></a> | |
| 410 <h4>RadonMetricsPlugin.cancelRawMetricsBatch</h4> | 539 <h4>RadonMetricsPlugin.cancelRawMetricsBatch</h4> |
| 411 <b>cancelRawMetricsBatch</b>(<i></i>) | 540 <b>cancelRawMetricsBatch</b>(<i></i>) |
| 541 | |
| 412 <p> | 542 <p> |
| 413 Public method to cancel all batch jobs. | 543 Public method to cancel all batch jobs. |
| 414 </p><a NAME="RadonMetricsPlugin.cyclomaticComplexity" ID="RadonMetricsPlugin.cyclomaticComplexity"></a> | 544 </p> |
| 545 <a NAME="RadonMetricsPlugin.cyclomaticComplexity" ID="RadonMetricsPlugin.cyclomaticComplexity"></a> | |
| 415 <h4>RadonMetricsPlugin.cyclomaticComplexity</h4> | 546 <h4>RadonMetricsPlugin.cyclomaticComplexity</h4> |
| 416 <b>cyclomaticComplexity</b>(<i>lang, filename, source</i>) | 547 <b>cyclomaticComplexity</b>(<i>lang, filename, source</i>) |
| 548 | |
| 417 <p> | 549 <p> |
| 418 Public method to prepare cyclomatic complexity calculation on one | 550 Public method to prepare cyclomatic complexity calculation on one |
| 419 Python source file. | 551 Python source file. |
| 420 </p><dl> | 552 </p> |
| 553 <dl> | |
| 554 | |
| 421 <dt><i>lang</i> (str or None)</dt> | 555 <dt><i>lang</i> (str or None)</dt> |
| 422 <dd> | 556 <dd> |
| 423 language of the file or None to determine by internal | 557 language of the file or None to determine by internal |
| 424 algorithm | 558 algorithm |
| 425 </dd><dt><i>filename</i> (str)</dt> | 559 </dd> |
| 560 <dt><i>filename</i> (str)</dt> | |
| 426 <dd> | 561 <dd> |
| 427 source filename | 562 source filename |
| 428 </dd><dt><i>source</i> (str)</dt> | 563 </dd> |
| 564 <dt><i>source</i> (str)</dt> | |
| 429 <dd> | 565 <dd> |
| 430 string containing the code | 566 string containing the code |
| 431 </dd> | 567 </dd> |
| 432 </dl><a NAME="RadonMetricsPlugin.cyclomaticComplexityBatch" ID="RadonMetricsPlugin.cyclomaticComplexityBatch"></a> | 568 </dl> |
| 569 <a NAME="RadonMetricsPlugin.cyclomaticComplexityBatch" ID="RadonMetricsPlugin.cyclomaticComplexityBatch"></a> | |
| 433 <h4>RadonMetricsPlugin.cyclomaticComplexityBatch</h4> | 570 <h4>RadonMetricsPlugin.cyclomaticComplexityBatch</h4> |
| 434 <b>cyclomaticComplexityBatch</b>(<i>argumentsList</i>) | 571 <b>cyclomaticComplexityBatch</b>(<i>argumentsList</i>) |
| 572 | |
| 435 <p> | 573 <p> |
| 436 Public method to prepare cyclomatic complexity calculation on multiple | 574 Public method to prepare cyclomatic complexity calculation on multiple |
| 437 Python source files. | 575 Python source files. |
| 438 </p><dl> | 576 </p> |
| 577 <dl> | |
| 578 | |
| 439 <dt><i>argumentsList</i> ((str, str))</dt> | 579 <dt><i>argumentsList</i> ((str, str))</dt> |
| 440 <dd> | 580 <dd> |
| 441 list of arguments tuples with each tuple | 581 list of arguments tuples with each tuple |
| 442 containing filename and source | 582 containing filename and source |
| 443 </dd> | 583 </dd> |
| 444 </dl><a NAME="RadonMetricsPlugin.deactivate" ID="RadonMetricsPlugin.deactivate"></a> | 584 </dl> |
| 585 <a NAME="RadonMetricsPlugin.deactivate" ID="RadonMetricsPlugin.deactivate"></a> | |
| 445 <h4>RadonMetricsPlugin.deactivate</h4> | 586 <h4>RadonMetricsPlugin.deactivate</h4> |
| 446 <b>deactivate</b>(<i></i>) | 587 <b>deactivate</b>(<i></i>) |
| 588 | |
| 447 <p> | 589 <p> |
| 448 Public method to deactivate this plug-in. | 590 Public method to deactivate this plug-in. |
| 449 </p><a NAME="RadonMetricsPlugin.maintainabilityIndex" ID="RadonMetricsPlugin.maintainabilityIndex"></a> | 591 </p> |
| 592 <a NAME="RadonMetricsPlugin.maintainabilityIndex" ID="RadonMetricsPlugin.maintainabilityIndex"></a> | |
| 450 <h4>RadonMetricsPlugin.maintainabilityIndex</h4> | 593 <h4>RadonMetricsPlugin.maintainabilityIndex</h4> |
| 451 <b>maintainabilityIndex</b>(<i>lang, filename, source</i>) | 594 <b>maintainabilityIndex</b>(<i>lang, filename, source</i>) |
| 595 | |
| 452 <p> | 596 <p> |
| 453 Public method to prepare maintainability index calculation on one | 597 Public method to prepare maintainability index calculation on one |
| 454 Python source file. | 598 Python source file. |
| 455 </p><dl> | 599 </p> |
| 600 <dl> | |
| 601 | |
| 456 <dt><i>lang</i> (str or None)</dt> | 602 <dt><i>lang</i> (str or None)</dt> |
| 457 <dd> | 603 <dd> |
| 458 language of the file or None to determine by internal | 604 language of the file or None to determine by internal |
| 459 algorithm | 605 algorithm |
| 460 </dd><dt><i>filename</i> (str)</dt> | 606 </dd> |
| 607 <dt><i>filename</i> (str)</dt> | |
| 461 <dd> | 608 <dd> |
| 462 source filename | 609 source filename |
| 463 </dd><dt><i>source</i> (str)</dt> | 610 </dd> |
| 611 <dt><i>source</i> (str)</dt> | |
| 464 <dd> | 612 <dd> |
| 465 string containing the code | 613 string containing the code |
| 466 </dd> | 614 </dd> |
| 467 </dl><a NAME="RadonMetricsPlugin.maintainabilityIndexBatch" ID="RadonMetricsPlugin.maintainabilityIndexBatch"></a> | 615 </dl> |
| 616 <a NAME="RadonMetricsPlugin.maintainabilityIndexBatch" ID="RadonMetricsPlugin.maintainabilityIndexBatch"></a> | |
| 468 <h4>RadonMetricsPlugin.maintainabilityIndexBatch</h4> | 617 <h4>RadonMetricsPlugin.maintainabilityIndexBatch</h4> |
| 469 <b>maintainabilityIndexBatch</b>(<i>argumentsList</i>) | 618 <b>maintainabilityIndexBatch</b>(<i>argumentsList</i>) |
| 619 | |
| 470 <p> | 620 <p> |
| 471 Public method to prepare maintainability index calculation on multiple | 621 Public method to prepare maintainability index calculation on multiple |
| 472 Python source files. | 622 Python source files. |
| 473 </p><dl> | 623 </p> |
| 624 <dl> | |
| 625 | |
| 474 <dt><i>argumentsList</i> ((str, str))</dt> | 626 <dt><i>argumentsList</i> ((str, str))</dt> |
| 475 <dd> | 627 <dd> |
| 476 list of arguments tuples with each tuple | 628 list of arguments tuples with each tuple |
| 477 containing filename and source | 629 containing filename and source |
| 478 </dd> | 630 </dd> |
| 479 </dl><a NAME="RadonMetricsPlugin.metricsCalculationDone" ID="RadonMetricsPlugin.metricsCalculationDone"></a> | 631 </dl> |
| 632 <a NAME="RadonMetricsPlugin.metricsCalculationDone" ID="RadonMetricsPlugin.metricsCalculationDone"></a> | |
| 480 <h4>RadonMetricsPlugin.metricsCalculationDone</h4> | 633 <h4>RadonMetricsPlugin.metricsCalculationDone</h4> |
| 481 <b>metricsCalculationDone</b>(<i>type_, filename, result</i>) | 634 <b>metricsCalculationDone</b>(<i>type_, filename, result</i>) |
| 635 | |
| 482 <p> | 636 <p> |
| 483 Public slot to dispatch the result. | 637 Public slot to dispatch the result. |
| 484 </p><dl> | 638 </p> |
| 639 <dl> | |
| 640 | |
| 485 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> | 641 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> |
| 486 <dd> | 642 <dd> |
| 487 type of the calculated metrics | 643 type of the calculated metrics |
| 488 </dd><dt><i>filename</i> (str)</dt> | 644 </dd> |
| 645 <dt><i>filename</i> (str)</dt> | |
| 489 <dd> | 646 <dd> |
| 490 name of the file the results belong to | 647 name of the file the results belong to |
| 491 </dd><dt><i>result</i> (dict)</dt> | 648 </dd> |
| 649 <dt><i>result</i> (dict)</dt> | |
| 492 <dd> | 650 <dd> |
| 493 result dictionary | 651 result dictionary |
| 494 </dd> | 652 </dd> |
| 495 </dl><a NAME="RadonMetricsPlugin.rawMetrics" ID="RadonMetricsPlugin.rawMetrics"></a> | 653 </dl> |
| 654 <a NAME="RadonMetricsPlugin.rawMetrics" ID="RadonMetricsPlugin.rawMetrics"></a> | |
| 496 <h4>RadonMetricsPlugin.rawMetrics</h4> | 655 <h4>RadonMetricsPlugin.rawMetrics</h4> |
| 497 <b>rawMetrics</b>(<i>lang, filename, source</i>) | 656 <b>rawMetrics</b>(<i>lang, filename, source</i>) |
| 657 | |
| 498 <p> | 658 <p> |
| 499 Public method to prepare raw code metrics calculation on one Python | 659 Public method to prepare raw code metrics calculation on one Python |
| 500 source file. | 660 source file. |
| 501 </p><dl> | 661 </p> |
| 662 <dl> | |
| 663 | |
| 502 <dt><i>lang</i> (str or None)</dt> | 664 <dt><i>lang</i> (str or None)</dt> |
| 503 <dd> | 665 <dd> |
| 504 language of the file or None to determine by internal | 666 language of the file or None to determine by internal |
| 505 algorithm | 667 algorithm |
| 506 </dd><dt><i>filename</i> (str)</dt> | 668 </dd> |
| 669 <dt><i>filename</i> (str)</dt> | |
| 507 <dd> | 670 <dd> |
| 508 source filename | 671 source filename |
| 509 </dd><dt><i>source</i> (str)</dt> | 672 </dd> |
| 673 <dt><i>source</i> (str)</dt> | |
| 510 <dd> | 674 <dd> |
| 511 string containing the code | 675 string containing the code |
| 512 </dd> | 676 </dd> |
| 513 </dl><a NAME="RadonMetricsPlugin.rawMetricsBatch" ID="RadonMetricsPlugin.rawMetricsBatch"></a> | 677 </dl> |
| 678 <a NAME="RadonMetricsPlugin.rawMetricsBatch" ID="RadonMetricsPlugin.rawMetricsBatch"></a> | |
| 514 <h4>RadonMetricsPlugin.rawMetricsBatch</h4> | 679 <h4>RadonMetricsPlugin.rawMetricsBatch</h4> |
| 515 <b>rawMetricsBatch</b>(<i>argumentsList</i>) | 680 <b>rawMetricsBatch</b>(<i>argumentsList</i>) |
| 681 | |
| 516 <p> | 682 <p> |
| 517 Public method to prepare raw code metrics calculation on multiple | 683 Public method to prepare raw code metrics calculation on multiple |
| 518 Python source files. | 684 Python source files. |
| 519 </p><dl> | 685 </p> |
| 686 <dl> | |
| 687 | |
| 520 <dt><i>argumentsList</i> ((str, str))</dt> | 688 <dt><i>argumentsList</i> ((str, str))</dt> |
| 521 <dd> | 689 <dd> |
| 522 list of arguments tuples with each tuple | 690 list of arguments tuples with each tuple |
| 523 containing filename and source | 691 containing filename and source |
| 524 </dd> | 692 </dd> |
| 525 </dl><a NAME="RadonMetricsPlugin.serviceErrorPy2" ID="RadonMetricsPlugin.serviceErrorPy2"></a> | 693 </dl> |
| 526 <h4>RadonMetricsPlugin.serviceErrorPy2</h4> | 694 <a NAME="RadonMetricsPlugin.serviceErrorPy3" ID="RadonMetricsPlugin.serviceErrorPy3"></a> |
| 527 <b>serviceErrorPy2</b>(<i>type_, fx, lang, fn, msg</i>) | |
| 528 <p> | |
| 529 Public slot handling service errors for Python 2. | |
| 530 </p><dl> | |
| 531 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> | |
| 532 <dd> | |
| 533 type of the calculated metrics | |
| 534 </dd><dt><i>fx</i> (str)</dt> | |
| 535 <dd> | |
| 536 service name | |
| 537 </dd><dt><i>lang</i> (str)</dt> | |
| 538 <dd> | |
| 539 language | |
| 540 </dd><dt><i>fn</i> (str)</dt> | |
| 541 <dd> | |
| 542 file name | |
| 543 </dd><dt><i>msg</i> (str)</dt> | |
| 544 <dd> | |
| 545 message text | |
| 546 </dd> | |
| 547 </dl><a NAME="RadonMetricsPlugin.serviceErrorPy3" ID="RadonMetricsPlugin.serviceErrorPy3"></a> | |
| 548 <h4>RadonMetricsPlugin.serviceErrorPy3</h4> | 695 <h4>RadonMetricsPlugin.serviceErrorPy3</h4> |
| 549 <b>serviceErrorPy3</b>(<i>type_, fx, lang, fn, msg</i>) | 696 <b>serviceErrorPy3</b>(<i>type_, fx, lang, fn, msg</i>) |
| 697 | |
| 550 <p> | 698 <p> |
| 551 Public slot handling service errors for Python 3. | 699 Public slot handling service errors for Python 3. |
| 552 </p><dl> | 700 </p> |
| 701 <dl> | |
| 702 | |
| 553 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> | 703 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> |
| 554 <dd> | 704 <dd> |
| 555 type of the calculated metrics | 705 type of the calculated metrics |
| 556 </dd><dt><i>fx</i> (str)</dt> | 706 </dd> |
| 707 <dt><i>fx</i> (str)</dt> | |
| 557 <dd> | 708 <dd> |
| 558 service name | 709 service name |
| 559 </dd><dt><i>lang</i> (str)</dt> | 710 </dd> |
| 711 <dt><i>lang</i> (str)</dt> | |
| 560 <dd> | 712 <dd> |
| 561 language | 713 language |
| 562 </dd><dt><i>fn</i> (str)</dt> | 714 </dd> |
| 715 <dt><i>fn</i> (str)</dt> | |
| 563 <dd> | 716 <dd> |
| 564 file name | 717 file name |
| 565 </dd><dt><i>msg</i> (str)</dt> | 718 </dd> |
| 719 <dt><i>msg</i> (str)</dt> | |
| 566 <dd> | 720 <dd> |
| 567 message text | 721 message text |
| 568 </dd> | 722 </dd> |
| 569 </dl> | 723 </dl> |
| 570 <div align="right"><a href="#top">Up</a></div> | 724 <div align="right"><a href="#top">Up</a></div> |
