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.RadonMetrics.MaintainabilityIndexDialog</h1> |
23 <h1>Plugin_Metrics_Radon.RadonMetrics.MaintainabilityIndexDialog</h1> |
|
24 |
23 <p> |
25 <p> |
24 Module implementing a dialog to show maintainability indexes. |
26 Module implementing a dialog to show maintainability indexes. |
25 </p> |
27 </p> |
26 <h3>Global Attributes</h3> |
28 <h3>Global Attributes</h3> |
|
29 |
27 <table> |
30 <table> |
28 <tr><td>None</td></tr> |
31 <tr><td>None</td></tr> |
29 </table> |
32 </table> |
30 <h3>Classes</h3> |
33 <h3>Classes</h3> |
31 <table> |
34 |
|
35 <table> |
|
36 |
32 <tr> |
37 <tr> |
33 <td><a href="#MaintainabilityIndexDialog">MaintainabilityIndexDialog</a></td> |
38 <td><a href="#MaintainabilityIndexDialog">MaintainabilityIndexDialog</a></td> |
34 <td>Class implementing a dialog to show maintainability indexes.</td> |
39 <td>Class implementing a dialog to show maintainability indexes.</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="MaintainabilityIndexDialog" ID="MaintainabilityIndexDialog"></a> |
49 <a NAME="MaintainabilityIndexDialog" ID="MaintainabilityIndexDialog"></a> |
43 <h2>MaintainabilityIndexDialog</h2> |
50 <h2>MaintainabilityIndexDialog</h2> |
|
51 |
44 <p> |
52 <p> |
45 Class implementing a dialog to show maintainability indexes. |
53 Class implementing a dialog to show maintainability indexes. |
46 </p> |
54 </p> |
47 <h3>Derived from</h3> |
55 <h3>Derived from</h3> |
48 QDialog, Ui_MaintainabilityIndexDialog |
56 QDialog, Ui_MaintainabilityIndexDialog |
49 <h3>Class Attributes</h3> |
57 <h3>Class Attributes</h3> |
|
58 |
50 <table> |
59 <table> |
51 <tr><td>FilePathRole</td></tr> |
60 <tr><td>FilePathRole</td></tr> |
52 </table> |
61 </table> |
53 <h3>Class Methods</h3> |
62 <h3>Class Methods</h3> |
|
63 |
54 <table> |
64 <table> |
55 <tr><td>None</td></tr> |
65 <tr><td>None</td></tr> |
56 </table> |
66 </table> |
57 <h3>Methods</h3> |
67 <h3>Methods</h3> |
58 <table> |
68 |
|
69 <table> |
|
70 |
59 <tr> |
71 <tr> |
60 <td><a href="#MaintainabilityIndexDialog.__init__">MaintainabilityIndexDialog</a></td> |
72 <td><a href="#MaintainabilityIndexDialog.__init__">MaintainabilityIndexDialog</a></td> |
61 <td>Constructor</td> |
73 <td>Constructor</td> |
62 </tr><tr> |
74 </tr> |
|
75 <tr> |
63 <td><a href="#MaintainabilityIndexDialog.__batchFinished">__batchFinished</a></td> |
76 <td><a href="#MaintainabilityIndexDialog.__batchFinished">__batchFinished</a></td> |
64 <td>Private slot handling the completion of a batch job.</td> |
77 <td>Private slot handling the completion of a batch job.</td> |
65 </tr><tr> |
78 </tr> |
|
79 <tr> |
66 <td><a href="#MaintainabilityIndexDialog.__createErrorItem">__createErrorItem</a></td> |
80 <td><a href="#MaintainabilityIndexDialog.__createErrorItem">__createErrorItem</a></td> |
67 <td>Private slot to create a new error item in the result list.</td> |
81 <td>Private slot to create a new error item in the result list.</td> |
68 </tr><tr> |
82 </tr> |
|
83 <tr> |
69 <td><a href="#MaintainabilityIndexDialog.__createResultItem">__createResultItem</a></td> |
84 <td><a href="#MaintainabilityIndexDialog.__createResultItem">__createResultItem</a></td> |
70 <td>Private slot to create a new item in the result list.</td> |
85 <td>Private slot to create a new item in the result list.</td> |
71 </tr><tr> |
86 </tr> |
|
87 <tr> |
72 <td><a href="#MaintainabilityIndexDialog.__finish">__finish</a></td> |
88 <td><a href="#MaintainabilityIndexDialog.__finish">__finish</a></td> |
73 <td>Private slot called when the action or the user pressed the button.</td> |
89 <td>Private slot called when the action or the user pressed the button.</td> |
74 </tr><tr> |
90 </tr> |
|
91 <tr> |
75 <td><a href="#MaintainabilityIndexDialog.__processError">__processError</a></td> |
92 <td><a href="#MaintainabilityIndexDialog.__processError">__processError</a></td> |
76 <td>Private slot to process an error indication from the service.</td> |
93 <td>Private slot to process an error indication from the service.</td> |
77 </tr><tr> |
94 </tr> |
|
95 <tr> |
78 <td><a href="#MaintainabilityIndexDialog.__processResult">__processResult</a></td> |
96 <td><a href="#MaintainabilityIndexDialog.__processResult">__processResult</a></td> |
79 <td>Private slot called after perfoming a maintainability index calculation on one file.</td> |
97 <td>Private slot called after perfoming a maintainability index calculation on one file.</td> |
80 </tr><tr> |
98 </tr> |
|
99 <tr> |
81 <td><a href="#MaintainabilityIndexDialog.__resizeResultColumns">__resizeResultColumns</a></td> |
100 <td><a href="#MaintainabilityIndexDialog.__resizeResultColumns">__resizeResultColumns</a></td> |
82 <td>Private method to resize the list columns.</td> |
101 <td>Private method to resize the list columns.</td> |
83 </tr><tr> |
102 </tr> |
|
103 <tr> |
84 <td><a href="#MaintainabilityIndexDialog.clear">clear</a></td> |
104 <td><a href="#MaintainabilityIndexDialog.clear">clear</a></td> |
85 <td>Public method to clear all results.</td> |
105 <td>Public method to clear all results.</td> |
86 </tr><tr> |
106 </tr> |
|
107 <tr> |
87 <td><a href="#MaintainabilityIndexDialog.maintainabilityIndex">maintainabilityIndex</a></td> |
108 <td><a href="#MaintainabilityIndexDialog.maintainabilityIndex">maintainabilityIndex</a></td> |
88 <td>Public method to start a maintainability index calculation for one Python file.</td> |
109 <td>Public method to start a maintainability index calculation for one Python file.</td> |
89 </tr><tr> |
110 </tr> |
|
111 <tr> |
90 <td><a href="#MaintainabilityIndexDialog.maintainabilityIndexBatch">maintainabilityIndexBatch</a></td> |
112 <td><a href="#MaintainabilityIndexDialog.maintainabilityIndexBatch">maintainabilityIndexBatch</a></td> |
91 <td>Public method to start a maintainability index calculation batch job.</td> |
113 <td>Public method to start a maintainability index calculation batch job.</td> |
92 </tr><tr> |
114 </tr> |
|
115 <tr> |
93 <td><a href="#MaintainabilityIndexDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
116 <td><a href="#MaintainabilityIndexDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
94 <td>Private slot called by a button of the button box clicked.</td> |
117 <td>Private slot called by a button of the button box clicked.</td> |
95 </tr><tr> |
118 </tr> |
|
119 <tr> |
96 <td><a href="#MaintainabilityIndexDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td> |
120 <td><a href="#MaintainabilityIndexDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td> |
97 <td>Private slot to handle the activation of a result item.</td> |
121 <td>Private slot to handle the activation of a result item.</td> |
98 </tr><tr> |
122 </tr> |
|
123 <tr> |
99 <td><a href="#MaintainabilityIndexDialog.on_startButton_clicked">on_startButton_clicked</a></td> |
124 <td><a href="#MaintainabilityIndexDialog.on_startButton_clicked">on_startButton_clicked</a></td> |
100 <td>Private slot to start a maintainability index run.</td> |
125 <td>Private slot to start a maintainability index run.</td> |
101 </tr><tr> |
126 </tr> |
|
127 <tr> |
102 <td><a href="#MaintainabilityIndexDialog.prepare">prepare</a></td> |
128 <td><a href="#MaintainabilityIndexDialog.prepare">prepare</a></td> |
103 <td>Public method to prepare the dialog with a list of filenames.</td> |
129 <td>Public method to prepare the dialog with a list of filenames.</td> |
104 </tr><tr> |
130 </tr> |
|
131 <tr> |
105 <td><a href="#MaintainabilityIndexDialog.start">start</a></td> |
132 <td><a href="#MaintainabilityIndexDialog.start">start</a></td> |
106 <td>Public slot to start the maintainability index determination.</td> |
133 <td>Public slot to start the maintainability index determination.</td> |
107 </tr> |
134 </tr> |
108 </table> |
135 </table> |
109 <h3>Static Methods</h3> |
136 <h3>Static Methods</h3> |
|
137 |
110 <table> |
138 <table> |
111 <tr><td>None</td></tr> |
139 <tr><td>None</td></tr> |
112 </table> |
140 </table> |
|
141 |
113 <a NAME="MaintainabilityIndexDialog.__init__" ID="MaintainabilityIndexDialog.__init__"></a> |
142 <a NAME="MaintainabilityIndexDialog.__init__" ID="MaintainabilityIndexDialog.__init__"></a> |
114 <h4>MaintainabilityIndexDialog (Constructor)</h4> |
143 <h4>MaintainabilityIndexDialog (Constructor)</h4> |
115 <b>MaintainabilityIndexDialog</b>(<i>radonService, parent=None</i>) |
144 <b>MaintainabilityIndexDialog</b>(<i>radonService, parent=None</i>) |
|
145 |
116 <p> |
146 <p> |
117 Constructor |
147 Constructor |
118 </p><dl> |
148 </p> |
|
149 <dl> |
|
150 |
119 <dt><i>radonService</i> (RadonMetricsPlugin)</dt> |
151 <dt><i>radonService</i> (RadonMetricsPlugin)</dt> |
120 <dd> |
152 <dd> |
121 reference to the service |
153 reference to the service |
122 </dd><dt><i>parent</i> (QWidget)</dt> |
154 </dd> |
|
155 <dt><i>parent</i> (QWidget)</dt> |
123 <dd> |
156 <dd> |
124 reference to the parent widget |
157 reference to the parent widget |
125 </dd> |
158 </dd> |
126 </dl><a NAME="MaintainabilityIndexDialog.__batchFinished" ID="MaintainabilityIndexDialog.__batchFinished"></a> |
159 </dl> |
|
160 <a NAME="MaintainabilityIndexDialog.__batchFinished" ID="MaintainabilityIndexDialog.__batchFinished"></a> |
127 <h4>MaintainabilityIndexDialog.__batchFinished</h4> |
161 <h4>MaintainabilityIndexDialog.__batchFinished</h4> |
128 <b>__batchFinished</b>(<i>type_</i>) |
162 <b>__batchFinished</b>(<i>type_</i>) |
|
163 |
129 <p> |
164 <p> |
130 Private slot handling the completion of a batch job. |
165 Private slot handling the completion of a batch job. |
131 </p><dl> |
166 </p> |
|
167 <dl> |
|
168 |
132 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> |
169 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> |
133 <dd> |
170 <dd> |
134 type of the calculated metrics |
171 type of the calculated metrics |
135 </dd> |
172 </dd> |
136 </dl><a NAME="MaintainabilityIndexDialog.__createErrorItem" ID="MaintainabilityIndexDialog.__createErrorItem"></a> |
173 </dl> |
|
174 <a NAME="MaintainabilityIndexDialog.__createErrorItem" ID="MaintainabilityIndexDialog.__createErrorItem"></a> |
137 <h4>MaintainabilityIndexDialog.__createErrorItem</h4> |
175 <h4>MaintainabilityIndexDialog.__createErrorItem</h4> |
138 <b>__createErrorItem</b>(<i>filename, message</i>) |
176 <b>__createErrorItem</b>(<i>filename, message</i>) |
|
177 |
139 <p> |
178 <p> |
140 Private slot to create a new error item in the result list. |
179 Private slot to create a new error item in the result list. |
141 </p><dl> |
180 </p> |
|
181 <dl> |
|
182 |
142 <dt><i>filename</i> (str)</dt> |
183 <dt><i>filename</i> (str)</dt> |
143 <dd> |
184 <dd> |
144 name of the file |
185 name of the file |
145 </dd><dt><i>message</i> (str)</dt> |
186 </dd> |
|
187 <dt><i>message</i> (str)</dt> |
146 <dd> |
188 <dd> |
147 error message |
189 error message |
148 </dd> |
190 </dd> |
149 </dl><a NAME="MaintainabilityIndexDialog.__createResultItem" ID="MaintainabilityIndexDialog.__createResultItem"></a> |
191 </dl> |
|
192 <a NAME="MaintainabilityIndexDialog.__createResultItem" ID="MaintainabilityIndexDialog.__createResultItem"></a> |
150 <h4>MaintainabilityIndexDialog.__createResultItem</h4> |
193 <h4>MaintainabilityIndexDialog.__createResultItem</h4> |
151 <b>__createResultItem</b>(<i>filename, values</i>) |
194 <b>__createResultItem</b>(<i>filename, values</i>) |
|
195 |
152 <p> |
196 <p> |
153 Private slot to create a new item in the result list. |
197 Private slot to create a new item in the result list. |
154 </p><dl> |
198 </p> |
|
199 <dl> |
|
200 |
155 <dt><i>filename</i> (str)</dt> |
201 <dt><i>filename</i> (str)</dt> |
156 <dd> |
202 <dd> |
157 name of the file |
203 name of the file |
158 </dd><dt><i>values</i> (dict)</dt> |
204 </dd> |
|
205 <dt><i>values</i> (dict)</dt> |
159 <dd> |
206 <dd> |
160 values to be displayed |
207 values to be displayed |
161 </dd> |
208 </dd> |
162 </dl><a NAME="MaintainabilityIndexDialog.__finish" ID="MaintainabilityIndexDialog.__finish"></a> |
209 </dl> |
|
210 <a NAME="MaintainabilityIndexDialog.__finish" ID="MaintainabilityIndexDialog.__finish"></a> |
163 <h4>MaintainabilityIndexDialog.__finish</h4> |
211 <h4>MaintainabilityIndexDialog.__finish</h4> |
164 <b>__finish</b>(<i></i>) |
212 <b>__finish</b>(<i></i>) |
|
213 |
165 <p> |
214 <p> |
166 Private slot called when the action or the user pressed the button. |
215 Private slot called when the action or the user pressed the button. |
167 </p><a NAME="MaintainabilityIndexDialog.__processError" ID="MaintainabilityIndexDialog.__processError"></a> |
216 </p> |
|
217 <a NAME="MaintainabilityIndexDialog.__processError" ID="MaintainabilityIndexDialog.__processError"></a> |
168 <h4>MaintainabilityIndexDialog.__processError</h4> |
218 <h4>MaintainabilityIndexDialog.__processError</h4> |
169 <b>__processError</b>(<i>type_, fn, msg</i>) |
219 <b>__processError</b>(<i>type_, fn, msg</i>) |
|
220 |
170 <p> |
221 <p> |
171 Private slot to process an error indication from the service. |
222 Private slot to process an error indication from the service. |
172 </p><dl> |
223 </p> |
|
224 <dl> |
|
225 |
173 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> |
226 <dt><i>type_</i> (str, one of ["raw", "mi", "cc"])</dt> |
174 <dd> |
227 <dd> |
175 type of the calculated metrics |
228 type of the calculated metrics |
176 </dd><dt><i>fn</i> (str)</dt> |
229 </dd> |
|
230 <dt><i>fn</i> (str)</dt> |
177 <dd> |
231 <dd> |
178 filename of the file |
232 filename of the file |
179 </dd><dt><i>msg</i> (str)</dt> |
233 </dd> |
|
234 <dt><i>msg</i> (str)</dt> |
180 <dd> |
235 <dd> |
181 error message |
236 error message |
182 </dd> |
237 </dd> |
183 </dl><a NAME="MaintainabilityIndexDialog.__processResult" ID="MaintainabilityIndexDialog.__processResult"></a> |
238 </dl> |
|
239 <a NAME="MaintainabilityIndexDialog.__processResult" ID="MaintainabilityIndexDialog.__processResult"></a> |
184 <h4>MaintainabilityIndexDialog.__processResult</h4> |
240 <h4>MaintainabilityIndexDialog.__processResult</h4> |
185 <b>__processResult</b>(<i>fn, result</i>) |
241 <b>__processResult</b>(<i>fn, result</i>) |
|
242 |
186 <p> |
243 <p> |
187 Private slot called after perfoming a maintainability index calculation |
244 Private slot called after perfoming a maintainability index calculation |
188 on one file. |
245 on one file. |
189 </p><dl> |
246 </p> |
|
247 <dl> |
|
248 |
190 <dt><i>fn</i> (str)</dt> |
249 <dt><i>fn</i> (str)</dt> |
191 <dd> |
250 <dd> |
192 filename of the file |
251 filename of the file |
193 </dd><dt><i>result</i> (dict)</dt> |
252 </dd> |
|
253 <dt><i>result</i> (dict)</dt> |
194 <dd> |
254 <dd> |
195 result dict |
255 result dict |
196 </dd> |
256 </dd> |
197 </dl><a NAME="MaintainabilityIndexDialog.__resizeResultColumns" ID="MaintainabilityIndexDialog.__resizeResultColumns"></a> |
257 </dl> |
|
258 <a NAME="MaintainabilityIndexDialog.__resizeResultColumns" ID="MaintainabilityIndexDialog.__resizeResultColumns"></a> |
198 <h4>MaintainabilityIndexDialog.__resizeResultColumns</h4> |
259 <h4>MaintainabilityIndexDialog.__resizeResultColumns</h4> |
199 <b>__resizeResultColumns</b>(<i></i>) |
260 <b>__resizeResultColumns</b>(<i></i>) |
|
261 |
200 <p> |
262 <p> |
201 Private method to resize the list columns. |
263 Private method to resize the list columns. |
202 </p><a NAME="MaintainabilityIndexDialog.clear" ID="MaintainabilityIndexDialog.clear"></a> |
264 </p> |
|
265 <a NAME="MaintainabilityIndexDialog.clear" ID="MaintainabilityIndexDialog.clear"></a> |
203 <h4>MaintainabilityIndexDialog.clear</h4> |
266 <h4>MaintainabilityIndexDialog.clear</h4> |
204 <b>clear</b>(<i></i>) |
267 <b>clear</b>(<i></i>) |
|
268 |
205 <p> |
269 <p> |
206 Public method to clear all results. |
270 Public method to clear all results. |
207 </p><a NAME="MaintainabilityIndexDialog.maintainabilityIndex" ID="MaintainabilityIndexDialog.maintainabilityIndex"></a> |
271 </p> |
|
272 <a NAME="MaintainabilityIndexDialog.maintainabilityIndex" ID="MaintainabilityIndexDialog.maintainabilityIndex"></a> |
208 <h4>MaintainabilityIndexDialog.maintainabilityIndex</h4> |
273 <h4>MaintainabilityIndexDialog.maintainabilityIndex</h4> |
209 <b>maintainabilityIndex</b>(<i>codestring=''</i>) |
274 <b>maintainabilityIndex</b>(<i>codestring=''</i>) |
|
275 |
210 <p> |
276 <p> |
211 Public method to start a maintainability index calculation for one |
277 Public method to start a maintainability index calculation for one |
212 Python file. |
278 Python file. |
213 </p><p> |
279 </p> |
|
280 <p> |
214 The results are reported to the __processResult slot. |
281 The results are reported to the __processResult slot. |
215 </p><dl> |
282 </p> |
|
283 <dl> |
|
284 |
216 <dt><i>codestring=</i> (str)</dt> |
285 <dt><i>codestring=</i> (str)</dt> |
217 <dd> |
286 <dd> |
218 optional sourcestring |
287 optional sourcestring |
219 </dd> |
288 </dd> |
220 </dl><a NAME="MaintainabilityIndexDialog.maintainabilityIndexBatch" ID="MaintainabilityIndexDialog.maintainabilityIndexBatch"></a> |
289 </dl> |
|
290 <a NAME="MaintainabilityIndexDialog.maintainabilityIndexBatch" ID="MaintainabilityIndexDialog.maintainabilityIndexBatch"></a> |
221 <h4>MaintainabilityIndexDialog.maintainabilityIndexBatch</h4> |
291 <h4>MaintainabilityIndexDialog.maintainabilityIndexBatch</h4> |
222 <b>maintainabilityIndexBatch</b>(<i></i>) |
292 <b>maintainabilityIndexBatch</b>(<i></i>) |
|
293 |
223 <p> |
294 <p> |
224 Public method to start a maintainability index calculation batch job. |
295 Public method to start a maintainability index calculation batch job. |
225 </p><p> |
296 </p> |
|
297 <p> |
226 The results are reported to the __processResult slot. |
298 The results are reported to the __processResult slot. |
227 </p><a NAME="MaintainabilityIndexDialog.on_buttonBox_clicked" ID="MaintainabilityIndexDialog.on_buttonBox_clicked"></a> |
299 </p> |
|
300 <a NAME="MaintainabilityIndexDialog.on_buttonBox_clicked" ID="MaintainabilityIndexDialog.on_buttonBox_clicked"></a> |
228 <h4>MaintainabilityIndexDialog.on_buttonBox_clicked</h4> |
301 <h4>MaintainabilityIndexDialog.on_buttonBox_clicked</h4> |
229 <b>on_buttonBox_clicked</b>(<i>button</i>) |
302 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
303 |
230 <p> |
304 <p> |
231 Private slot called by a button of the button box clicked. |
305 Private slot called by a button of the button box clicked. |
232 </p><dl> |
306 </p> |
|
307 <dl> |
|
308 |
233 <dt><i>button</i> (QAbstractButton)</dt> |
309 <dt><i>button</i> (QAbstractButton)</dt> |
234 <dd> |
310 <dd> |
235 button that was clicked |
311 button that was clicked |
236 </dd> |
312 </dd> |
237 </dl><a NAME="MaintainabilityIndexDialog.on_resultList_itemActivated" ID="MaintainabilityIndexDialog.on_resultList_itemActivated"></a> |
313 </dl> |
|
314 <a NAME="MaintainabilityIndexDialog.on_resultList_itemActivated" ID="MaintainabilityIndexDialog.on_resultList_itemActivated"></a> |
238 <h4>MaintainabilityIndexDialog.on_resultList_itemActivated</h4> |
315 <h4>MaintainabilityIndexDialog.on_resultList_itemActivated</h4> |
239 <b>on_resultList_itemActivated</b>(<i>item, column</i>) |
316 <b>on_resultList_itemActivated</b>(<i>item, column</i>) |
|
317 |
240 <p> |
318 <p> |
241 Private slot to handle the activation of a result item. |
319 Private slot to handle the activation of a result item. |
242 </p><dl> |
320 </p> |
|
321 <dl> |
|
322 |
243 <dt><i>item</i> (QTreeWidgetItem)</dt> |
323 <dt><i>item</i> (QTreeWidgetItem)</dt> |
244 <dd> |
324 <dd> |
245 reference to the activated item |
325 reference to the activated item |
246 </dd><dt><i>column</i> (int)</dt> |
326 </dd> |
|
327 <dt><i>column</i> (int)</dt> |
247 <dd> |
328 <dd> |
248 activated column |
329 activated column |
249 </dd> |
330 </dd> |
250 </dl><a NAME="MaintainabilityIndexDialog.on_startButton_clicked" ID="MaintainabilityIndexDialog.on_startButton_clicked"></a> |
331 </dl> |
|
332 <a NAME="MaintainabilityIndexDialog.on_startButton_clicked" ID="MaintainabilityIndexDialog.on_startButton_clicked"></a> |
251 <h4>MaintainabilityIndexDialog.on_startButton_clicked</h4> |
333 <h4>MaintainabilityIndexDialog.on_startButton_clicked</h4> |
252 <b>on_startButton_clicked</b>(<i></i>) |
334 <b>on_startButton_clicked</b>(<i></i>) |
|
335 |
253 <p> |
336 <p> |
254 Private slot to start a maintainability index run. |
337 Private slot to start a maintainability index run. |
255 </p><a NAME="MaintainabilityIndexDialog.prepare" ID="MaintainabilityIndexDialog.prepare"></a> |
338 </p> |
|
339 <a NAME="MaintainabilityIndexDialog.prepare" ID="MaintainabilityIndexDialog.prepare"></a> |
256 <h4>MaintainabilityIndexDialog.prepare</h4> |
340 <h4>MaintainabilityIndexDialog.prepare</h4> |
257 <b>prepare</b>(<i>fileList, project</i>) |
341 <b>prepare</b>(<i>fileList, project</i>) |
|
342 |
258 <p> |
343 <p> |
259 Public method to prepare the dialog with a list of filenames. |
344 Public method to prepare the dialog with a list of filenames. |
260 </p><dl> |
345 </p> |
|
346 <dl> |
|
347 |
261 <dt><i>fileList</i> (list of str)</dt> |
348 <dt><i>fileList</i> (list of str)</dt> |
262 <dd> |
349 <dd> |
263 list of filenames |
350 list of filenames |
264 </dd><dt><i>project</i> (Project)</dt> |
351 </dd> |
|
352 <dt><i>project</i> (Project)</dt> |
265 <dd> |
353 <dd> |
266 reference to the project object |
354 reference to the project object |
267 </dd> |
355 </dd> |
268 </dl><a NAME="MaintainabilityIndexDialog.start" ID="MaintainabilityIndexDialog.start"></a> |
356 </dl> |
|
357 <a NAME="MaintainabilityIndexDialog.start" ID="MaintainabilityIndexDialog.start"></a> |
269 <h4>MaintainabilityIndexDialog.start</h4> |
358 <h4>MaintainabilityIndexDialog.start</h4> |
270 <b>start</b>(<i>fn</i>) |
359 <b>start</b>(<i>fn</i>) |
|
360 |
271 <p> |
361 <p> |
272 Public slot to start the maintainability index determination. |
362 Public slot to start the maintainability index determination. |
273 </p><dl> |
363 </p> |
|
364 <dl> |
|
365 |
274 <dt><i>fn</i> (str or list of str)</dt> |
366 <dt><i>fn</i> (str or list of str)</dt> |
275 <dd> |
367 <dd> |
276 file or list of files or directory to show |
368 file or list of files or directory to show |
277 the maintainability index for |
369 the maintainability index for |
278 </dd> |
370 </dd> |