Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html
src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html
- branch
- eric7
- changeset 10437
- 2f70ca07f0af
- parent 10259
- b51dfacef37f
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 10436:f6881d10e995 | 10437:2f70ca07f0af |
|---|---|
| 116 <p> | 116 <p> |
| 117 Constructor | 117 Constructor |
| 118 </p> | 118 </p> |
| 119 <dl> | 119 <dl> |
| 120 | 120 |
| 121 <dt><i>options</i></dt> | 121 <dt><i>options</i> (optparse.Values)</dt> |
| 122 <dd> | 122 <dd> |
| 123 options for the report (optparse.Values) | 123 options for the report |
| 124 </dd> | 124 </dd> |
| 125 </dl> | 125 </dl> |
| 126 <a NAME="CodeStyleCheckerReport.error_args" ID="CodeStyleCheckerReport.error_args"></a> | 126 <a NAME="CodeStyleCheckerReport.error_args" ID="CodeStyleCheckerReport.error_args"></a> |
| 127 <h4>CodeStyleCheckerReport.error_args</h4> | 127 <h4>CodeStyleCheckerReport.error_args</h4> |
| 128 <b>error_args</b>(<i>line_number, offset, errorCode, check, *args</i>) | 128 <b>error_args</b>(<i>line_number, offset, errorCode, check, *args</i>) |
| 130 <p> | 130 <p> |
| 131 Public method to collect the error messages. | 131 Public method to collect the error messages. |
| 132 </p> | 132 </p> |
| 133 <dl> | 133 <dl> |
| 134 | 134 |
| 135 <dt><i>line_number</i></dt> | 135 <dt><i>line_number</i> (int)</dt> |
| 136 <dd> | 136 <dd> |
| 137 line number of the issue (integer) | 137 line number of the issue |
| 138 </dd> | 138 </dd> |
| 139 <dt><i>offset</i></dt> | 139 <dt><i>offset</i> (int)</dt> |
| 140 <dd> | 140 <dd> |
| 141 position within line of the issue (integer) | 141 position within line of the issue |
| 142 </dd> | 142 </dd> |
| 143 <dt><i>errorCode</i></dt> | 143 <dt><i>errorCode</i> (str)</dt> |
| 144 <dd> | 144 <dd> |
| 145 error message code (string) | 145 error message code |
| 146 </dd> | 146 </dd> |
| 147 <dt><i>check</i></dt> | 147 <dt><i>check</i> (function)</dt> |
| 148 <dd> | 148 <dd> |
| 149 reference to the checker function (function) | 149 reference to the checker function |
| 150 </dd> | 150 </dd> |
| 151 <dt><i>args</i></dt> | 151 <dt><i>args</i> (list)</dt> |
| 152 <dd> | 152 <dd> |
| 153 arguments for the message (list) | 153 arguments for the message |
| 154 </dd> | 154 </dd> |
| 155 </dl> | 155 </dl> |
| 156 <dl> | 156 <dl> |
| 157 <dt>Return:</dt> | 157 <dt>Return:</dt> |
| 158 <dd> | 158 <dd> |
| 159 error code (string) | 159 error code |
| 160 </dd> | |
| 161 </dl> | |
| 162 <dl> | |
| 163 <dt>Return Type:</dt> | |
| 164 <dd> | |
| 165 str | |
| 160 </dd> | 166 </dd> |
| 161 </dl> | 167 </dl> |
| 162 <div align="right"><a href="#top">Up</a></div> | 168 <div align="right"><a href="#top">Up</a></div> |
| 163 <hr /> | 169 <hr /> |
| 164 <hr /> | 170 <hr /> |
| 341 Function to extract flags starting and ending with '__' from a line | 347 Function to extract flags starting and ending with '__' from a line |
| 342 comment. | 348 comment. |
| 343 </p> | 349 </p> |
| 344 <dl> | 350 <dl> |
| 345 | 351 |
| 346 <dt><i>line</i></dt> | 352 <dt><i>line</i> (str)</dt> |
| 347 <dd> | 353 <dd> |
| 348 line to extract flags from (string) | 354 line to extract flags from |
| 349 </dd> | 355 </dd> |
| 350 <dt><i>startComment</i></dt> | 356 <dt><i>startComment</i> (str)</dt> |
| 351 <dd> | 357 <dd> |
| 352 string identifying the start of the comment (string) | 358 string identifying the start of the comment |
| 353 </dd> | 359 </dd> |
| 354 <dt><i>endComment</i></dt> | 360 <dt><i>endComment</i> (str)</dt> |
| 355 <dd> | 361 <dd> |
| 356 string identifying the end of a comment (string) | 362 string identifying the end of a comment |
| 357 </dd> | 363 </dd> |
| 358 <dt><i>flagsLine</i></dt> | 364 <dt><i>flagsLine</i> (bool)</dt> |
| 359 <dd> | 365 <dd> |
| 360 flag indicating to check for a flags only line (bool) | 366 flag indicating to check for a flags only line |
| 361 </dd> | 367 </dd> |
| 362 </dl> | 368 </dl> |
| 363 <dl> | 369 <dl> |
| 364 <dt>Return:</dt> | 370 <dt>Return:</dt> |
| 365 <dd> | 371 <dd> |
| 366 list containing the extracted flags (list of strings) | 372 list containing the extracted flags |
| 373 </dd> | |
| 374 </dl> | |
| 375 <dl> | |
| 376 <dt>Return Type:</dt> | |
| 377 <dd> | |
| 378 list of str | |
| 367 </dd> | 379 </dd> |
| 368 </dl> | 380 </dl> |
| 369 <div align="right"><a href="#top">Up</a></div> | 381 <div align="right"><a href="#top">Up</a></div> |
| 370 <hr /> | 382 <hr /> |
| 371 <hr /> | 383 <hr /> |
| 410 Initialize the batch service and return the entry point. | 422 Initialize the batch service and return the entry point. |
| 411 </p> | 423 </p> |
| 412 <dl> | 424 <dl> |
| 413 <dt>Return:</dt> | 425 <dt>Return:</dt> |
| 414 <dd> | 426 <dd> |
| 415 the entry point for the background client (function) | 427 the entry point for the background client |
| 428 </dd> | |
| 429 </dl> | |
| 430 <dl> | |
| 431 <dt>Return Type:</dt> | |
| 432 <dd> | |
| 433 function | |
| 416 </dd> | 434 </dd> |
| 417 </dl> | 435 </dl> |
| 418 <div align="right"><a href="#top">Up</a></div> | 436 <div align="right"><a href="#top">Up</a></div> |
| 419 <hr /> | 437 <hr /> |
| 420 <hr /> | 438 <hr /> |
| 426 Initialize the service and return the entry point. | 444 Initialize the service and return the entry point. |
| 427 </p> | 445 </p> |
| 428 <dl> | 446 <dl> |
| 429 <dt>Return:</dt> | 447 <dt>Return:</dt> |
| 430 <dd> | 448 <dd> |
| 431 the entry point for the background client (function) | 449 the entry point for the background client |
| 450 </dd> | |
| 451 </dl> | |
| 452 <dl> | |
| 453 <dt>Return Type:</dt> | |
| 454 <dd> | |
| 455 function | |
| 432 </dd> | 456 </dd> |
| 433 </dl> | 457 </dl> |
| 434 <div align="right"><a href="#top">Up</a></div> | 458 <div align="right"><a href="#top">Up</a></div> |
| 435 <hr /> | 459 <hr /> |
| 436 <hr /> | 460 <hr /> |
| 474 <p> | 498 <p> |
| 475 Module function acting as the parallel worker for the style check. | 499 Module function acting as the parallel worker for the style check. |
| 476 </p> | 500 </p> |
| 477 <dl> | 501 <dl> |
| 478 | 502 |
| 479 <dt><i>inputQueue</i></dt> | 503 <dt><i>inputQueue</i> (multiprocessing.Queue)</dt> |
| 480 <dd> | 504 <dd> |
| 481 input queue (multiprocessing.Queue) | 505 input queue |
| 482 </dd> | 506 </dd> |
| 483 <dt><i>outputQueue</i></dt> | 507 <dt><i>outputQueue</i> (multiprocessing.Queue)</dt> |
| 484 <dd> | 508 <dd> |
| 485 output queue (multiprocessing.Queue) | 509 output queue |
| 486 </dd> | 510 </dd> |
| 487 </dl> | 511 </dl> |
| 488 <div align="right"><a href="#top">Up</a></div> | 512 <div align="right"><a href="#top">Up</a></div> |
| 489 <hr /> | 513 <hr /> |
| 490 </body></html> | 514 </body></html> |
