Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html
src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html
- branch
- eric7
- changeset 10070
- 9f5758c0fec1
- parent 9236
- db53a9efe7ef
- child 10259
- b51dfacef37f
equal
deleted
inserted
replaced
| 10069:435cc5875135 | 10070:9f5758c0fec1 |
|---|---|
| 62 <td><a href="#DocStyleChecker.__init__">DocStyleChecker</a></td> | 62 <td><a href="#DocStyleChecker.__init__">DocStyleChecker</a></td> |
| 63 <td>Constructor</td> | 63 <td>Constructor</td> |
| 64 </tr> | 64 </tr> |
| 65 <tr> | 65 <tr> |
| 66 <td><a href="#DocStyleChecker.__checkBackslashes">__checkBackslashes</a></td> | 66 <td><a href="#DocStyleChecker.__checkBackslashes">__checkBackslashes</a></td> |
| 67 <td>Private method to check, that all docstrings containing backslashes are surrounded by raw triple double quotes.</td> | 67 <td></td> |
| 68 </tr> | 68 </tr> |
| 69 <tr> | 69 <tr> |
| 70 <td><a href="#DocStyleChecker.__checkBlankAfterLastParagraph">__checkBlankAfterLastParagraph</a></td> | 70 <td><a href="#DocStyleChecker.__checkBlankAfterLastParagraph">__checkBlankAfterLastParagraph</a></td> |
| 71 <td>Private method to check, that the last paragraph of docstrings is followed by a blank line.</td> | 71 <td></td> |
| 72 </tr> | 72 </tr> |
| 73 <tr> | 73 <tr> |
| 74 <td><a href="#DocStyleChecker.__checkBlankAfterSummary">__checkBlankAfterSummary</a></td> | 74 <td><a href="#DocStyleChecker.__checkBlankAfterSummary">__checkBlankAfterSummary</a></td> |
| 75 <td>Private method to check, that docstring summaries are followed by a blank line.</td> | 75 <td></td> |
| 76 </tr> | 76 </tr> |
| 77 <tr> | 77 <tr> |
| 78 <td><a href="#DocStyleChecker.__checkBlankBeforeAndAfterClass">__checkBlankBeforeAndAfterClass</a></td> | 78 <td><a href="#DocStyleChecker.__checkBlankBeforeAndAfterClass">__checkBlankBeforeAndAfterClass</a></td> |
| 79 <td>Private method to check, that class docstrings have one blank line around them.</td> | 79 <td>Private method to check, that class docstrings have one blank line around them.</td> |
| 80 </tr> | 80 </tr> |
| 82 <td><a href="#DocStyleChecker.__checkClassDocstring">__checkClassDocstring</a></td> | 82 <td><a href="#DocStyleChecker.__checkClassDocstring">__checkClassDocstring</a></td> |
| 83 <td>Private method to check, that all public functions and methods have a docstring.</td> | 83 <td>Private method to check, that all public functions and methods have a docstring.</td> |
| 84 </tr> | 84 </tr> |
| 85 <tr> | 85 <tr> |
| 86 <td><a href="#DocStyleChecker.__checkEndsWithPeriod">__checkEndsWithPeriod</a></td> | 86 <td><a href="#DocStyleChecker.__checkEndsWithPeriod">__checkEndsWithPeriod</a></td> |
| 87 <td>Private method to check, that docstring summaries end with a period.</td> | 87 <td></td> |
| 88 </tr> | 88 </tr> |
| 89 <tr> | 89 <tr> |
| 90 <td><a href="#DocStyleChecker.__checkEricBlankAfterSummary">__checkEricBlankAfterSummary</a></td> | 90 <td><a href="#DocStyleChecker.__checkEricBlankAfterSummary">__checkEricBlankAfterSummary</a></td> |
| 91 <td>Private method to check, that docstring summaries are followed by a blank line.</td> | 91 <td></td> |
| 92 </tr> | 92 </tr> |
| 93 <tr> | 93 <tr> |
| 94 <td><a href="#DocStyleChecker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td> | 94 <td><a href="#DocStyleChecker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td> |
| 95 <td>Private method to check, that docstring summaries end with a period.</td> | 95 <td></td> |
| 96 </tr> | 96 </tr> |
| 97 <tr> | 97 <tr> |
| 98 <td><a href="#DocStyleChecker.__checkEricException">__checkEricException</a></td> | 98 <td><a href="#DocStyleChecker.__checkEricException">__checkEricException</a></td> |
| 99 <td>Private method to check, that docstrings contain an @exception line if they raise an exception and don't otherwise.</td> | 99 <td>Private method to check, that docstrings contain an @exception line if they raise an exception and don't otherwise.</td> |
| 100 </tr> | 100 </tr> |
| 110 <td><a href="#DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction">__checkEricNoBlankBeforeAndAfterClassOrFunction</a></td> | 110 <td><a href="#DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction">__checkEricNoBlankBeforeAndAfterClassOrFunction</a></td> |
| 111 <td>Private method to check, that class and function/method docstrings have no blank line around them.</td> | 111 <td>Private method to check, that class and function/method docstrings have no blank line around them.</td> |
| 112 </tr> | 112 </tr> |
| 113 <tr> | 113 <tr> |
| 114 <td><a href="#DocStyleChecker.__checkEricQuotesOnSeparateLines">__checkEricQuotesOnSeparateLines</a></td> | 114 <td><a href="#DocStyleChecker.__checkEricQuotesOnSeparateLines">__checkEricQuotesOnSeparateLines</a></td> |
| 115 <td>Private method to check, that leading and trailing quotes are on a line by themselves.</td> | 115 <td></td> |
| 116 </tr> | 116 </tr> |
| 117 <tr> | 117 <tr> |
| 118 <td><a href="#DocStyleChecker.__checkEricReturn">__checkEricReturn</a></td> | 118 <td><a href="#DocStyleChecker.__checkEricReturn">__checkEricReturn</a></td> |
| 119 <td>Private method to check, that docstrings contain an @return line if they return anything and don't otherwise.</td> | 119 <td>Private method to check, that docstrings contain an @return line if they return anything and don't otherwise.</td> |
| 120 </tr> | 120 </tr> |
| 134 <td><a href="#DocStyleChecker.__checkFunctionDocstring">__checkFunctionDocstring</a></td> | 134 <td><a href="#DocStyleChecker.__checkFunctionDocstring">__checkFunctionDocstring</a></td> |
| 135 <td>Private method to check, that all public functions and methods have a docstring.</td> | 135 <td>Private method to check, that all public functions and methods have a docstring.</td> |
| 136 </tr> | 136 </tr> |
| 137 <tr> | 137 <tr> |
| 138 <td><a href="#DocStyleChecker.__checkImperativeMood">__checkImperativeMood</a></td> | 138 <td><a href="#DocStyleChecker.__checkImperativeMood">__checkImperativeMood</a></td> |
| 139 <td>Private method to check, that docstring summaries are in imperative mood.</td> | 139 <td></td> |
| 140 </tr> | 140 </tr> |
| 141 <tr> | 141 <tr> |
| 142 <td><a href="#DocStyleChecker.__checkIndent">__checkIndent</a></td> | 142 <td><a href="#DocStyleChecker.__checkIndent">__checkIndent</a></td> |
| 143 <td>Private method to check, that docstrings are properly indented.</td> | 143 <td>Private method to check, that docstrings are properly indented.</td> |
| 144 </tr> | 144 </tr> |
| 162 <td><a href="#DocStyleChecker.__checkReturnType">__checkReturnType</a></td> | 162 <td><a href="#DocStyleChecker.__checkReturnType">__checkReturnType</a></td> |
| 163 <td>Private method to check, that docstrings mention the return value type.</td> | 163 <td>Private method to check, that docstrings mention the return value type.</td> |
| 164 </tr> | 164 </tr> |
| 165 <tr> | 165 <tr> |
| 166 <td><a href="#DocStyleChecker.__checkSummary">__checkSummary</a></td> | 166 <td><a href="#DocStyleChecker.__checkSummary">__checkSummary</a></td> |
| 167 <td>Private method to check, that docstring summaries contain some text.</td> | 167 <td></td> |
| 168 </tr> | 168 </tr> |
| 169 <tr> | 169 <tr> |
| 170 <td><a href="#DocStyleChecker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td> | 170 <td><a href="#DocStyleChecker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td> |
| 171 <td>Private method to check, that all docstrings are surrounded by triple double quotes.</td> | 171 <td></td> |
| 172 </tr> | 172 </tr> |
| 173 <tr> | 173 <tr> |
| 174 <td><a href="#DocStyleChecker.__error">__error</a></td> | 174 <td><a href="#DocStyleChecker.__error">__error</a></td> |
| 175 <td>Private method to record an issue.</td> | 175 <td>Private method to record an issue.</td> |
| 176 </tr> | 176 </tr> |
| 287 </dl> | 287 </dl> |
| 288 <a NAME="DocStyleChecker.__checkBackslashes" ID="DocStyleChecker.__checkBackslashes"></a> | 288 <a NAME="DocStyleChecker.__checkBackslashes" ID="DocStyleChecker.__checkBackslashes"></a> |
| 289 <h4>DocStyleChecker.__checkBackslashes</h4> | 289 <h4>DocStyleChecker.__checkBackslashes</h4> |
| 290 <b>__checkBackslashes</b>(<i>docstringContext, context</i>) | 290 <b>__checkBackslashes</b>(<i>docstringContext, context</i>) |
| 291 | 291 |
| 292 <p> | |
| 293 Private method to check, that all docstrings containing | |
| 294 backslashes are surrounded by raw triple double quotes. | |
| 295 </p> | |
| 296 <dl> | |
| 297 | |
| 298 <dt><i>docstringContext</i></dt> | |
| 299 <dd> | |
| 300 docstring context (DocStyleContext) | |
| 301 </dd> | |
| 302 <dt><i>context</i></dt> | |
| 303 <dd> | |
| 304 context of the docstring (DocStyleContext) | |
| 305 </dd> | |
| 306 </dl> | |
| 307 <a NAME="DocStyleChecker.__checkBlankAfterLastParagraph" ID="DocStyleChecker.__checkBlankAfterLastParagraph"></a> | 292 <a NAME="DocStyleChecker.__checkBlankAfterLastParagraph" ID="DocStyleChecker.__checkBlankAfterLastParagraph"></a> |
| 308 <h4>DocStyleChecker.__checkBlankAfterLastParagraph</h4> | 293 <h4>DocStyleChecker.__checkBlankAfterLastParagraph</h4> |
| 309 <b>__checkBlankAfterLastParagraph</b>(<i>docstringContext, context</i>) | 294 <b>__checkBlankAfterLastParagraph</b>(<i>docstringContext, context</i>) |
| 310 | 295 |
| 311 <p> | |
| 312 Private method to check, that the last paragraph of docstrings is | |
| 313 followed by a blank line. | |
| 314 </p> | |
| 315 <dl> | |
| 316 | |
| 317 <dt><i>docstringContext</i></dt> | |
| 318 <dd> | |
| 319 docstring context (DocStyleContext) | |
| 320 </dd> | |
| 321 <dt><i>context</i></dt> | |
| 322 <dd> | |
| 323 context of the docstring (DocStyleContext) | |
| 324 </dd> | |
| 325 </dl> | |
| 326 <a NAME="DocStyleChecker.__checkBlankAfterSummary" ID="DocStyleChecker.__checkBlankAfterSummary"></a> | 296 <a NAME="DocStyleChecker.__checkBlankAfterSummary" ID="DocStyleChecker.__checkBlankAfterSummary"></a> |
| 327 <h4>DocStyleChecker.__checkBlankAfterSummary</h4> | 297 <h4>DocStyleChecker.__checkBlankAfterSummary</h4> |
| 328 <b>__checkBlankAfterSummary</b>(<i>docstringContext, context</i>) | 298 <b>__checkBlankAfterSummary</b>(<i>docstringContext, context</i>) |
| 329 | 299 |
| 330 <p> | |
| 331 Private method to check, that docstring summaries are followed | |
| 332 by a blank line. | |
| 333 </p> | |
| 334 <dl> | |
| 335 | |
| 336 <dt><i>docstringContext</i></dt> | |
| 337 <dd> | |
| 338 docstring context (DocStyleContext) | |
| 339 </dd> | |
| 340 <dt><i>context</i></dt> | |
| 341 <dd> | |
| 342 context of the docstring (DocStyleContext) | |
| 343 </dd> | |
| 344 </dl> | |
| 345 <a NAME="DocStyleChecker.__checkBlankBeforeAndAfterClass" ID="DocStyleChecker.__checkBlankBeforeAndAfterClass"></a> | 300 <a NAME="DocStyleChecker.__checkBlankBeforeAndAfterClass" ID="DocStyleChecker.__checkBlankBeforeAndAfterClass"></a> |
| 346 <h4>DocStyleChecker.__checkBlankBeforeAndAfterClass</h4> | 301 <h4>DocStyleChecker.__checkBlankBeforeAndAfterClass</h4> |
| 347 <b>__checkBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>) | 302 <b>__checkBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>) |
| 348 | 303 |
| 349 <p> | 304 <p> |
| 382 </dl> | 337 </dl> |
| 383 <a NAME="DocStyleChecker.__checkEndsWithPeriod" ID="DocStyleChecker.__checkEndsWithPeriod"></a> | 338 <a NAME="DocStyleChecker.__checkEndsWithPeriod" ID="DocStyleChecker.__checkEndsWithPeriod"></a> |
| 384 <h4>DocStyleChecker.__checkEndsWithPeriod</h4> | 339 <h4>DocStyleChecker.__checkEndsWithPeriod</h4> |
| 385 <b>__checkEndsWithPeriod</b>(<i>docstringContext, context</i>) | 340 <b>__checkEndsWithPeriod</b>(<i>docstringContext, context</i>) |
| 386 | 341 |
| 387 <p> | |
| 388 Private method to check, that docstring summaries end with a period. | |
| 389 </p> | |
| 390 <dl> | |
| 391 | |
| 392 <dt><i>docstringContext</i></dt> | |
| 393 <dd> | |
| 394 docstring context (DocStyleContext) | |
| 395 </dd> | |
| 396 <dt><i>context</i></dt> | |
| 397 <dd> | |
| 398 context of the docstring (DocStyleContext) | |
| 399 </dd> | |
| 400 </dl> | |
| 401 <a NAME="DocStyleChecker.__checkEricBlankAfterSummary" ID="DocStyleChecker.__checkEricBlankAfterSummary"></a> | 342 <a NAME="DocStyleChecker.__checkEricBlankAfterSummary" ID="DocStyleChecker.__checkEricBlankAfterSummary"></a> |
| 402 <h4>DocStyleChecker.__checkEricBlankAfterSummary</h4> | 343 <h4>DocStyleChecker.__checkEricBlankAfterSummary</h4> |
| 403 <b>__checkEricBlankAfterSummary</b>(<i>docstringContext, context</i>) | 344 <b>__checkEricBlankAfterSummary</b>(<i>docstringContext, context</i>) |
| 404 | 345 |
| 405 <p> | |
| 406 Private method to check, that docstring summaries are followed | |
| 407 by a blank line. | |
| 408 </p> | |
| 409 <dl> | |
| 410 | |
| 411 <dt><i>docstringContext</i></dt> | |
| 412 <dd> | |
| 413 docstring context (DocStyleContext) | |
| 414 </dd> | |
| 415 <dt><i>context</i></dt> | |
| 416 <dd> | |
| 417 context of the docstring (DocStyleContext) | |
| 418 </dd> | |
| 419 </dl> | |
| 420 <a NAME="DocStyleChecker.__checkEricEndsWithPeriod" ID="DocStyleChecker.__checkEricEndsWithPeriod"></a> | 346 <a NAME="DocStyleChecker.__checkEricEndsWithPeriod" ID="DocStyleChecker.__checkEricEndsWithPeriod"></a> |
| 421 <h4>DocStyleChecker.__checkEricEndsWithPeriod</h4> | 347 <h4>DocStyleChecker.__checkEricEndsWithPeriod</h4> |
| 422 <b>__checkEricEndsWithPeriod</b>(<i>docstringContext, context</i>) | 348 <b>__checkEricEndsWithPeriod</b>(<i>docstringContext, context</i>) |
| 423 | 349 |
| 424 <p> | |
| 425 Private method to check, that docstring summaries end with a period. | |
| 426 </p> | |
| 427 <dl> | |
| 428 | |
| 429 <dt><i>docstringContext</i></dt> | |
| 430 <dd> | |
| 431 docstring context (DocStyleContext) | |
| 432 </dd> | |
| 433 <dt><i>context</i></dt> | |
| 434 <dd> | |
| 435 context of the docstring (DocStyleContext) | |
| 436 </dd> | |
| 437 </dl> | |
| 438 <a NAME="DocStyleChecker.__checkEricException" ID="DocStyleChecker.__checkEricException"></a> | 350 <a NAME="DocStyleChecker.__checkEricException" ID="DocStyleChecker.__checkEricException"></a> |
| 439 <h4>DocStyleChecker.__checkEricException</h4> | 351 <h4>DocStyleChecker.__checkEricException</h4> |
| 440 <b>__checkEricException</b>(<i>docstringContext, context</i>) | 352 <b>__checkEricException</b>(<i>docstringContext, context</i>) |
| 441 | 353 |
| 442 <p> | 354 <p> |
| 518 </dl> | 430 </dl> |
| 519 <a NAME="DocStyleChecker.__checkEricQuotesOnSeparateLines" ID="DocStyleChecker.__checkEricQuotesOnSeparateLines"></a> | 431 <a NAME="DocStyleChecker.__checkEricQuotesOnSeparateLines" ID="DocStyleChecker.__checkEricQuotesOnSeparateLines"></a> |
| 520 <h4>DocStyleChecker.__checkEricQuotesOnSeparateLines</h4> | 432 <h4>DocStyleChecker.__checkEricQuotesOnSeparateLines</h4> |
| 521 <b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>) | 433 <b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>) |
| 522 | 434 |
| 523 <p> | |
| 524 Private method to check, that leading and trailing quotes are on | |
| 525 a line by themselves. | |
| 526 </p> | |
| 527 <dl> | |
| 528 | |
| 529 <dt><i>docstringContext</i></dt> | |
| 530 <dd> | |
| 531 docstring context (DocStyleContext) | |
| 532 </dd> | |
| 533 <dt><i>context</i></dt> | |
| 534 <dd> | |
| 535 context of the docstring (DocStyleContext) | |
| 536 </dd> | |
| 537 </dl> | |
| 538 <a NAME="DocStyleChecker.__checkEricReturn" ID="DocStyleChecker.__checkEricReturn"></a> | 435 <a NAME="DocStyleChecker.__checkEricReturn" ID="DocStyleChecker.__checkEricReturn"></a> |
| 539 <h4>DocStyleChecker.__checkEricReturn</h4> | 436 <h4>DocStyleChecker.__checkEricReturn</h4> |
| 540 <b>__checkEricReturn</b>(<i>docstringContext, context</i>) | 437 <b>__checkEricReturn</b>(<i>docstringContext, context</i>) |
| 541 | 438 |
| 542 <p> | 439 <p> |
| 637 </dl> | 534 </dl> |
| 638 <a NAME="DocStyleChecker.__checkImperativeMood" ID="DocStyleChecker.__checkImperativeMood"></a> | 535 <a NAME="DocStyleChecker.__checkImperativeMood" ID="DocStyleChecker.__checkImperativeMood"></a> |
| 639 <h4>DocStyleChecker.__checkImperativeMood</h4> | 536 <h4>DocStyleChecker.__checkImperativeMood</h4> |
| 640 <b>__checkImperativeMood</b>(<i>docstringContext, context</i>) | 537 <b>__checkImperativeMood</b>(<i>docstringContext, context</i>) |
| 641 | 538 |
| 642 <p> | |
| 643 Private method to check, that docstring summaries are in | |
| 644 imperative mood. | |
| 645 </p> | |
| 646 <dl> | |
| 647 | |
| 648 <dt><i>docstringContext</i></dt> | |
| 649 <dd> | |
| 650 docstring context (DocStyleContext) | |
| 651 </dd> | |
| 652 <dt><i>context</i></dt> | |
| 653 <dd> | |
| 654 context of the docstring (DocStyleContext) | |
| 655 </dd> | |
| 656 </dl> | |
| 657 <a NAME="DocStyleChecker.__checkIndent" ID="DocStyleChecker.__checkIndent"></a> | 539 <a NAME="DocStyleChecker.__checkIndent" ID="DocStyleChecker.__checkIndent"></a> |
| 658 <h4>DocStyleChecker.__checkIndent</h4> | 540 <h4>DocStyleChecker.__checkIndent</h4> |
| 659 <b>__checkIndent</b>(<i>docstringContext, context</i>) | 541 <b>__checkIndent</b>(<i>docstringContext, context</i>) |
| 660 | 542 |
| 661 <p> | 543 <p> |
| 767 </dl> | 649 </dl> |
| 768 <a NAME="DocStyleChecker.__checkSummary" ID="DocStyleChecker.__checkSummary"></a> | 650 <a NAME="DocStyleChecker.__checkSummary" ID="DocStyleChecker.__checkSummary"></a> |
| 769 <h4>DocStyleChecker.__checkSummary</h4> | 651 <h4>DocStyleChecker.__checkSummary</h4> |
| 770 <b>__checkSummary</b>(<i>docstringContext, context</i>) | 652 <b>__checkSummary</b>(<i>docstringContext, context</i>) |
| 771 | 653 |
| 772 <p> | |
| 773 Private method to check, that docstring summaries contain some text. | |
| 774 </p> | |
| 775 <dl> | |
| 776 | |
| 777 <dt><i>docstringContext</i></dt> | |
| 778 <dd> | |
| 779 docstring context (DocStyleContext) | |
| 780 </dd> | |
| 781 <dt><i>context</i></dt> | |
| 782 <dd> | |
| 783 context of the docstring (DocStyleContext) | |
| 784 </dd> | |
| 785 </dl> | |
| 786 <a NAME="DocStyleChecker.__checkTripleDoubleQuotes" ID="DocStyleChecker.__checkTripleDoubleQuotes"></a> | 654 <a NAME="DocStyleChecker.__checkTripleDoubleQuotes" ID="DocStyleChecker.__checkTripleDoubleQuotes"></a> |
| 787 <h4>DocStyleChecker.__checkTripleDoubleQuotes</h4> | 655 <h4>DocStyleChecker.__checkTripleDoubleQuotes</h4> |
| 788 <b>__checkTripleDoubleQuotes</b>(<i>docstringContext, context</i>) | 656 <b>__checkTripleDoubleQuotes</b>(<i>docstringContext, context</i>) |
| 789 | 657 |
| 790 <p> | |
| 791 Private method to check, that all docstrings are surrounded | |
| 792 by triple double quotes. | |
| 793 </p> | |
| 794 <dl> | |
| 795 | |
| 796 <dt><i>docstringContext</i></dt> | |
| 797 <dd> | |
| 798 docstring context (DocStyleContext) | |
| 799 </dd> | |
| 800 <dt><i>context</i></dt> | |
| 801 <dd> | |
| 802 context of the docstring (DocStyleContext) | |
| 803 </dd> | |
| 804 </dl> | |
| 805 <a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a> | 658 <a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a> |
| 806 <h4>DocStyleChecker.__error</h4> | 659 <h4>DocStyleChecker.__error</h4> |
| 807 <b>__error</b>(<i>lineNumber, offset, code, *args</i>) | 660 <b>__error</b>(<i>lineNumber, offset, code, *args</i>) |
| 808 | 661 |
| 809 <p> | 662 <p> |
