46 </p> |
46 </p> |
47 <h3>Derived from</h3> |
47 <h3>Derived from</h3> |
48 QDialog, Ui_CodeStyleCheckerDialog |
48 QDialog, Ui_CodeStyleCheckerDialog |
49 <h3>Class Attributes</h3> |
49 <h3>Class Attributes</h3> |
50 <table> |
50 <table> |
51 <tr><td>codeRole</td></tr><tr><td>filenameRole</td></tr><tr><td>fixableRole</td></tr><tr><td>lineRole</td></tr><tr><td>messageRole</td></tr><tr><td>positionRole</td></tr> |
51 <tr><td>codeRole</td></tr><tr><td>filenameRole</td></tr><tr><td>fixableRole</td></tr><tr><td>ignoredRole</td></tr><tr><td>lineRole</td></tr><tr><td>messageRole</td></tr><tr><td>positionRole</td></tr> |
52 </table> |
52 </table> |
53 <h3>Class Methods</h3> |
53 <h3>Class Methods</h3> |
54 <table> |
54 <table> |
55 <tr><td>None</td></tr> |
55 <tr><td>None</td></tr> |
56 </table> |
56 </table> |
180 <dd> |
180 <dd> |
181 list of files to be checked (list of string) |
181 list of files to be checked (list of string) |
182 </dd> |
182 </dd> |
183 </dl><a NAME="CodeStyleCheckerDialog.__createResultItem" ID="CodeStyleCheckerDialog.__createResultItem"></a> |
183 </dl><a NAME="CodeStyleCheckerDialog.__createResultItem" ID="CodeStyleCheckerDialog.__createResultItem"></a> |
184 <h4>CodeStyleCheckerDialog.__createResultItem</h4> |
184 <h4>CodeStyleCheckerDialog.__createResultItem</h4> |
185 <b>__createResultItem</b>(<i>file, line, pos, message, fixed, autofixing</i>) |
185 <b>__createResultItem</b>(<i>file, line, pos, message, fixed, autofixing, ignored</i>) |
186 <p> |
186 <p> |
187 Private method to create an entry in the result list. |
187 Private method to create an entry in the result list. |
188 </p><dl> |
188 </p><dl> |
189 <dt><i>file</i></dt> |
189 <dt><i>file</i></dt> |
190 <dd> |
190 <dd> |
203 flag indicating a fixed issue (boolean) |
203 flag indicating a fixed issue (boolean) |
204 </dd><dt><i>autofixing</i></dt> |
204 </dd><dt><i>autofixing</i></dt> |
205 <dd> |
205 <dd> |
206 flag indicating, that we are fixing issues |
206 flag indicating, that we are fixing issues |
207 automatically (boolean) |
207 automatically (boolean) |
|
208 </dd><dt><i>ignored</i></dt> |
|
209 <dd> |
|
210 flag indicating an ignored issue (boolean) |
208 </dd> |
211 </dd> |
209 </dl><dl> |
212 </dl><dl> |
210 <dt>Returns:</dt> |
213 <dt>Returns:</dt> |
211 <dd> |
214 <dd> |
212 reference to the created item (QTreeWidgetItem) |
215 reference to the created item (QTreeWidgetItem) |
290 <dd> |
293 <dd> |
291 number of applied fixes (int) |
294 number of applied fixes (int) |
292 </dd><dt><i>results</i></dt> |
295 </dd><dt><i>results</i></dt> |
293 <dd> |
296 <dd> |
294 tuple for each found violation of style (tuple of |
297 tuple for each found violation of style (tuple of |
295 lineno (int), position (int), text (str), fixed (bool), |
298 lineno (int), position (int), text (str), ignored (bool), |
296 autofixing (bool)) |
299 fixed (bool), autofixing (bool)) |
297 </dd> |
300 </dd> |
298 </dl><a NAME="CodeStyleCheckerDialog.__resetStatistics" ID="CodeStyleCheckerDialog.__resetStatistics"></a> |
301 </dl><a NAME="CodeStyleCheckerDialog.__resetStatistics" ID="CodeStyleCheckerDialog.__resetStatistics"></a> |
299 <h4>CodeStyleCheckerDialog.__resetStatistics</h4> |
302 <h4>CodeStyleCheckerDialog.__resetStatistics</h4> |
300 <b>__resetStatistics</b>(<i></i>) |
303 <b>__resetStatistics</b>(<i></i>) |
301 <p> |
304 <p> |
329 <dd> |
332 <dd> |
330 reference to the code style fixer (CodeStyleFixer) |
333 reference to the code style fixer (CodeStyleFixer) |
331 </dd> |
334 </dd> |
332 </dl><a NAME="CodeStyleCheckerDialog.__updateStatistics" ID="CodeStyleCheckerDialog.__updateStatistics"></a> |
335 </dl><a NAME="CodeStyleCheckerDialog.__updateStatistics" ID="CodeStyleCheckerDialog.__updateStatistics"></a> |
333 <h4>CodeStyleCheckerDialog.__updateStatistics</h4> |
336 <h4>CodeStyleCheckerDialog.__updateStatistics</h4> |
334 <b>__updateStatistics</b>(<i>statistics, fixer</i>) |
337 <b>__updateStatistics</b>(<i>statistics, fixer, ignoredErrors</i>) |
335 <p> |
338 <p> |
336 Private method to update the collected statistics. |
339 Private method to update the collected statistics. |
337 </p><dl> |
340 </p><dl> |
338 <dt><i>statistics</i></dt> |
341 <dt><i>statistics</i></dt> |
339 <dd> |
342 <dd> |
340 dictionary of statistical data with |
343 dictionary of statistical data with |
341 message code as key and message count as value |
344 message code as key and message count as value |
342 </dd><dt><i>fixer</i></dt> |
345 </dd><dt><i>fixer</i></dt> |
343 <dd> |
346 <dd> |
344 reference to the code style fixer (CodeStyleFixer) |
347 reference to the code style fixer (CodeStyleFixer) |
|
348 </dd><dt><i>ignoredErrors</i></dt> |
|
349 <dd> |
|
350 number of ignored errors (integer) |
345 </dd> |
351 </dd> |
346 </dl><a NAME="CodeStyleCheckerDialog.check" ID="CodeStyleCheckerDialog.check"></a> |
352 </dl><a NAME="CodeStyleCheckerDialog.check" ID="CodeStyleCheckerDialog.check"></a> |
347 <h4>CodeStyleCheckerDialog.check</h4> |
353 <h4>CodeStyleCheckerDialog.check</h4> |
348 <b>check</b>(<i>codestring='', onlyFixes={}</i>) |
354 <b>check</b>(<i>codestring='', onlyFixes={}</i>) |
349 <p> |
355 <p> |