Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog.html

src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog.html

branch
eric7
changeset 10304
ff7d3d6b952d
parent 10070
9f5758c0fec1
child 10341
3fdffd9cc21d
equal deleted inserted replaced
10303:ee1aadab1215 10304:ff7d3d6b952d
73 <tr> 73 <tr>
74 <td><a href="#SyntaxCheckerDialog.__createErrorItem">__createErrorItem</a></td> 74 <td><a href="#SyntaxCheckerDialog.__createErrorItem">__createErrorItem</a></td>
75 <td>Private slot to create a new error item in the result list.</td> 75 <td>Private slot to create a new error item in the result list.</td>
76 </tr> 76 </tr>
77 <tr> 77 <tr>
78 <td><a href="#SyntaxCheckerDialog.__createFileStatistics">__createFileStatistics</a></td>
79 <td>Private method to return the file statistics entry.</td>
80 </tr>
81 <tr>
82 <td><a href="#SyntaxCheckerDialog.__createHeaderItem">__createHeaderItem</a></td>
83 <td>Private method to create a header item in the result list.</td>
84 </tr>
85 <tr>
78 <td><a href="#SyntaxCheckerDialog.__createResultItem">__createResultItem</a></td> 86 <td><a href="#SyntaxCheckerDialog.__createResultItem">__createResultItem</a></td>
79 <td>Private method to create an entry in the result list.</td> 87 <td>Private method to create an entry in the result list.</td>
80 </tr> 88 </tr>
81 <tr> 89 <tr>
90 <td><a href="#SyntaxCheckerDialog.__defaultStatistics">__defaultStatistics</a></td>
91 <td>Private method to return the default statistics entry.</td>
92 </tr>
93 <tr>
82 <td><a href="#SyntaxCheckerDialog.__finish">__finish</a></td> 94 <td><a href="#SyntaxCheckerDialog.__finish">__finish</a></td>
83 <td>Private slot called when the syntax check finished or the user pressed the button.</td> 95 <td>Private slot called when the syntax check finished or the user pressed the button.</td>
84 </tr> 96 </tr>
85 <tr> 97 <tr>
86 <td><a href="#SyntaxCheckerDialog.__processError">__processError</a></td> 98 <td><a href="#SyntaxCheckerDialog.__processError">__processError</a></td>
89 <tr> 101 <tr>
90 <td><a href="#SyntaxCheckerDialog.__processResult">__processResult</a></td> 102 <td><a href="#SyntaxCheckerDialog.__processResult">__processResult</a></td>
91 <td>Private slot to display the reported messages.</td> 103 <td>Private slot to display the reported messages.</td>
92 </tr> 104 </tr>
93 <tr> 105 <tr>
106 <td><a href="#SyntaxCheckerDialog.__resetStatistics">__resetStatistics</a></td>
107 <td>Private method to reset the statistics data.</td>
108 </tr>
109 <tr>
94 <td><a href="#SyntaxCheckerDialog.__resort">__resort</a></td> 110 <td><a href="#SyntaxCheckerDialog.__resort">__resort</a></td>
95 <td>Private method to resort the tree.</td> 111 <td>Private method to resort the tree.</td>
112 </tr>
113 <tr>
114 <td><a href="#SyntaxCheckerDialog.__updateStatistics">__updateStatistics</a></td>
115 <td>Private method to update the statistics.</td>
116 </tr>
117 <tr>
118 <td><a href="#SyntaxCheckerDialog.__updateStatisticsArea">__updateStatisticsArea</a></td>
119 <td>Private method to update the statistics area of the dialog.</td>
96 </tr> 120 </tr>
97 <tr> 121 <tr>
98 <td><a href="#SyntaxCheckerDialog.check">check</a></td> 122 <td><a href="#SyntaxCheckerDialog.check">check</a></td>
99 <td>Public method to start a check for one file.</td> 123 <td>Public method to start a check for one file.</td>
100 </tr> 124 </tr>
204 <dt><i>message</i> (str)</dt> 228 <dt><i>message</i> (str)</dt>
205 <dd> 229 <dd>
206 error message 230 error message
207 </dd> 231 </dd>
208 </dl> 232 </dl>
233 <a NAME="SyntaxCheckerDialog.__createFileStatistics" ID="SyntaxCheckerDialog.__createFileStatistics"></a>
234 <h4>SyntaxCheckerDialog.__createFileStatistics</h4>
235 <b>__createFileStatistics</b>(<i>problems</i>)
236
237 <p>
238 Private method to return the file statistics entry.
239 </p>
240 <dl>
241
242 <dt><i>problems</i> (dict)</dt>
243 <dd>
244 dictionary with the keys 'error', 'py_warnings' and
245 'warnings' which hold a list of issues each
246 </dd>
247 </dl>
248 <dl>
249 <dt>Return:</dt>
250 <dd>
251 dictionary with the file statistics
252 </dd>
253 </dl>
254 <dl>
255 <dt>Return Type:</dt>
256 <dd>
257 dict
258 </dd>
259 </dl>
260 <a NAME="SyntaxCheckerDialog.__createHeaderItem" ID="SyntaxCheckerDialog.__createHeaderItem"></a>
261 <h4>SyntaxCheckerDialog.__createHeaderItem</h4>
262 <b>__createHeaderItem</b>(<i>filename, fileStatistics=None</i>)
263
264 <p>
265 Private method to create a header item in the result list.
266 </p>
267 <dl>
268
269 <dt><i>filename</i> (str)</dt>
270 <dd>
271 file name of file
272 </dd>
273 <dt><i>fileStatistics</i> (dict (optional))</dt>
274 <dd>
275 dictionary containing statistical data of the check
276 result (defaults to None)
277 </dd>
278 </dl>
209 <a NAME="SyntaxCheckerDialog.__createResultItem" ID="SyntaxCheckerDialog.__createResultItem"></a> 279 <a NAME="SyntaxCheckerDialog.__createResultItem" ID="SyntaxCheckerDialog.__createResultItem"></a>
210 <h4>SyntaxCheckerDialog.__createResultItem</h4> 280 <h4>SyntaxCheckerDialog.__createResultItem</h4>
211 <b>__createResultItem</b>(<i>filename, line, index, error, sourcecode, isWarning=False</i>) 281 <b>__createResultItem</b>(<i>filename, line, index, error, sourcecode, isWarning=False</i>)
212 282
213 <p> 283 <p>
238 <dt><i>isWarning</i> (bool)</dt> 308 <dt><i>isWarning</i> (bool)</dt>
239 <dd> 309 <dd>
240 flag indicating a warning message 310 flag indicating a warning message
241 </dd> 311 </dd>
242 </dl> 312 </dl>
313 <a NAME="SyntaxCheckerDialog.__defaultStatistics" ID="SyntaxCheckerDialog.__defaultStatistics"></a>
314 <h4>SyntaxCheckerDialog.__defaultStatistics</h4>
315 <b>__defaultStatistics</b>(<i></i>)
316
317 <p>
318 Private method to return the default statistics entry.
319 </p>
320 <dl>
321 <dt>Return:</dt>
322 <dd>
323 dictionary with default statistics entry
324 </dd>
325 </dl>
326 <dl>
327 <dt>Return Type:</dt>
328 <dd>
329 dict
330 </dd>
331 </dl>
243 <a NAME="SyntaxCheckerDialog.__finish" ID="SyntaxCheckerDialog.__finish"></a> 332 <a NAME="SyntaxCheckerDialog.__finish" ID="SyntaxCheckerDialog.__finish"></a>
244 <h4>SyntaxCheckerDialog.__finish</h4> 333 <h4>SyntaxCheckerDialog.__finish</h4>
245 <b>__finish</b>(<i></i>) 334 <b>__finish</b>(<i></i>)
246 335
247 <p> 336 <p>
279 <dd> 368 <dd>
280 filename of the checked file 369 filename of the checked file
281 </dd> 370 </dd>
282 <dt><i>problems</i> (dict)</dt> 371 <dt><i>problems</i> (dict)</dt>
283 <dd> 372 <dd>
284 dictionary with the keys 'error' and 'warnings' which 373 dictionary with the keys 'error', 'py_warnings' and
285 hold a list containing details about the error/ warnings 374 'warnings' which hold a list containing details about the error or
286 (file name, line number, column, codestring (only at syntax 375 warnings (file name, line number, column, codestring (only at syntax
287 errors), the message) 376 errors), message)
377 </dd>
378 </dl>
379 <a NAME="SyntaxCheckerDialog.__resetStatistics" ID="SyntaxCheckerDialog.__resetStatistics"></a>
380 <h4>SyntaxCheckerDialog.__resetStatistics</h4>
381 <b>__resetStatistics</b>(<i>skipped</i>)
382
383 <p>
384 Private method to reset the statistics data.
385 </p>
386 <dl>
387
388 <dt><i>skipped</i> (int)</dt>
389 <dd>
390 number of files not being checked
288 </dd> 391 </dd>
289 </dl> 392 </dl>
290 <a NAME="SyntaxCheckerDialog.__resort" ID="SyntaxCheckerDialog.__resort"></a> 393 <a NAME="SyntaxCheckerDialog.__resort" ID="SyntaxCheckerDialog.__resort"></a>
291 <h4>SyntaxCheckerDialog.__resort</h4> 394 <h4>SyntaxCheckerDialog.__resort</h4>
292 <b>__resort</b>(<i></i>) 395 <b>__resort</b>(<i></i>)
293 396
294 <p> 397 <p>
295 Private method to resort the tree. 398 Private method to resort the tree.
296 </p> 399 </p>
400 <a NAME="SyntaxCheckerDialog.__updateStatistics" ID="SyntaxCheckerDialog.__updateStatistics"></a>
401 <h4>SyntaxCheckerDialog.__updateStatistics</h4>
402 <b>__updateStatistics</b>(<i>fileStatistics</i>)
403
404 <p>
405 Private method to update the statistics.
406 </p>
407 <dl>
408
409 <dt><i>fileStatistics</i> (dict)</dt>
410 <dd>
411 dictionary containing the file statistics
412 </dd>
413 </dl>
414 <a NAME="SyntaxCheckerDialog.__updateStatisticsArea" ID="SyntaxCheckerDialog.__updateStatisticsArea"></a>
415 <h4>SyntaxCheckerDialog.__updateStatisticsArea</h4>
416 <b>__updateStatisticsArea</b>(<i></i>)
417
418 <p>
419 Private method to update the statistics area of the dialog.
420 </p>
297 <a NAME="SyntaxCheckerDialog.check" ID="SyntaxCheckerDialog.check"></a> 421 <a NAME="SyntaxCheckerDialog.check" ID="SyntaxCheckerDialog.check"></a>
298 <h4>SyntaxCheckerDialog.check</h4> 422 <h4>SyntaxCheckerDialog.check</h4>
299 <b>check</b>(<i>codestring=""</i>) 423 <b>check</b>(<i>codestring=""</i>)
300 424
301 <p> 425 <p>
413 tuple containing the additional arguments 537 tuple containing the additional arguments
414 </dd> 538 </dd>
415 </dl> 539 </dl>
416 <a NAME="SyntaxCheckerDialog.start" ID="SyntaxCheckerDialog.start"></a> 540 <a NAME="SyntaxCheckerDialog.start" ID="SyntaxCheckerDialog.start"></a>
417 <h4>SyntaxCheckerDialog.start</h4> 541 <h4>SyntaxCheckerDialog.start</h4>
418 <b>start</b>(<i>fn, codestring=""</i>) 542 <b>start</b>(<i>fn, codestring="", skipped=0</i>)
419 543
420 <p> 544 <p>
421 Public slot to start the syntax check. 545 Public slot to start the syntax check.
422 </p> 546 </p>
423 <dl> 547 <dl>
428 </dd> 552 </dd>
429 <dt><i>codestring</i> (str)</dt> 553 <dt><i>codestring</i> (str)</dt>
430 <dd> 554 <dd>
431 string containing the code to be checked. If this is given, 555 string containing the code to be checked. If this is given,
432 fn must be a single file name. 556 fn must be a single file name.
557 </dd>
558 <dt><i>skipped</i> (int)</dt>
559 <dd>
560 number of files not being checked
433 </dd> 561 </dd>
434 </dl> 562 </dl>
435 <a NAME="SyntaxCheckerDialog.startForBrowser" ID="SyntaxCheckerDialog.startForBrowser"></a> 563 <a NAME="SyntaxCheckerDialog.startForBrowser" ID="SyntaxCheckerDialog.startForBrowser"></a>
436 <h4>SyntaxCheckerDialog.startForBrowser</h4> 564 <h4>SyntaxCheckerDialog.startForBrowser</h4>
437 <b>startForBrowser</b>(<i>fn</i>) 565 <b>startForBrowser</b>(<i>fn</i>)

Mercurial Repository: eric

eric ide

mercurial