Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html
Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html
- changeset 5732
- 34041e56ec42
- parent 3673
- e26d7d0c1088
- child 5812
- ffc31e1cff4e
equal
deleted
inserted
replaced
| 5729:e67c1c4f4abb | 5732:34041e56ec42 |
|---|---|
| 103 <td>Private method to check, that leading and trailing quotes are on a line by themselves.</td> | 103 <td>Private method to check, that leading and trailing quotes are on a line by themselves.</td> |
| 104 </tr><tr> | 104 </tr><tr> |
| 105 <td><a href="#DocStyleChecker.__checkEricReturn">__checkEricReturn</a></td> | 105 <td><a href="#DocStyleChecker.__checkEricReturn">__checkEricReturn</a></td> |
| 106 <td>Private method to check, that docstrings contain an @return line if they return anything and don't otherwise.</td> | 106 <td>Private method to check, that docstrings contain an @return line if they return anything and don't otherwise.</td> |
| 107 </tr><tr> | 107 </tr><tr> |
| 108 <td><a href="#DocStyleChecker.__checkEricSignal">__checkEricSignal</a></td> | |
| 109 <td>Private method to check, that docstrings contain an @signal line if they define signals and don't otherwise.</td> | |
| 110 </tr><tr> | |
| 108 <td><a href="#DocStyleChecker.__checkEricSummary">__checkEricSummary</a></td> | 111 <td><a href="#DocStyleChecker.__checkEricSummary">__checkEricSummary</a></td> |
| 109 <td>Private method to check, that method docstring summaries start with specific words.</td> | 112 <td>Private method to check, that method docstring summaries start with specific words.</td> |
| 110 </tr><tr> | 113 </tr><tr> |
| 111 <td><a href="#DocStyleChecker.__checkFunctionDocstring">__checkFunctionDocstring</a></td> | 114 <td><a href="#DocStyleChecker.__checkFunctionDocstring">__checkFunctionDocstring</a></td> |
| 112 <td>Private method to check, that all public functions and methods have a docstring.</td> | 115 <td>Private method to check, that all public functions and methods have a docstring.</td> |
| 347 <h4>DocStyleChecker.__checkEricException</h4> | 350 <h4>DocStyleChecker.__checkEricException</h4> |
| 348 <b>__checkEricException</b>(<i>docstringContext, context</i>) | 351 <b>__checkEricException</b>(<i>docstringContext, context</i>) |
| 349 <p> | 352 <p> |
| 350 Private method to check, that docstrings contain an @exception line | 353 Private method to check, that docstrings contain an @exception line |
| 351 if they raise an exception and don't otherwise. | 354 if they raise an exception and don't otherwise. |
| 355 </p><p> | |
| 356 Note: This method also checks the raised and documented exceptions for | |
| 357 completeness (i.e. raised exceptions that are not documented or | |
| 358 documented exceptions that are not raised) | |
| 352 </p><dl> | 359 </p><dl> |
| 353 <dt><i>docstringContext</i></dt> | 360 <dt><i>docstringContext</i></dt> |
| 354 <dd> | 361 <dd> |
| 355 docstring context (DocStyleContext) | 362 docstring context (DocStyleContext) |
| 356 </dd><dt><i>context</i></dt> | 363 </dd><dt><i>context</i></dt> |
| 417 <h4>DocStyleChecker.__checkEricReturn</h4> | 424 <h4>DocStyleChecker.__checkEricReturn</h4> |
| 418 <b>__checkEricReturn</b>(<i>docstringContext, context</i>) | 425 <b>__checkEricReturn</b>(<i>docstringContext, context</i>) |
| 419 <p> | 426 <p> |
| 420 Private method to check, that docstrings contain an @return line | 427 Private method to check, that docstrings contain an @return line |
| 421 if they return anything and don't otherwise. | 428 if they return anything and don't otherwise. |
| 429 </p><dl> | |
| 430 <dt><i>docstringContext</i></dt> | |
| 431 <dd> | |
| 432 docstring context (DocStyleContext) | |
| 433 </dd><dt><i>context</i></dt> | |
| 434 <dd> | |
| 435 context of the docstring (DocStyleContext) | |
| 436 </dd> | |
| 437 </dl><a NAME="DocStyleChecker.__checkEricSignal" ID="DocStyleChecker.__checkEricSignal"></a> | |
| 438 <h4>DocStyleChecker.__checkEricSignal</h4> | |
| 439 <b>__checkEricSignal</b>(<i>docstringContext, context</i>) | |
| 440 <p> | |
| 441 Private method to check, that docstrings contain an @signal line | |
| 442 if they define signals and don't otherwise. | |
| 443 </p><p> | |
| 444 Note: This method also checks the defined and documented signals for | |
| 445 completeness (i.e. defined signals that are not documented or | |
| 446 documented signals that are not defined) | |
| 422 </p><dl> | 447 </p><dl> |
| 423 <dt><i>docstringContext</i></dt> | 448 <dt><i>docstringContext</i></dt> |
| 424 <dd> | 449 <dd> |
| 425 docstring context (DocStyleContext) | 450 docstring context (DocStyleContext) |
| 426 </dd><dt><i>context</i></dt> | 451 </dd><dt><i>context</i></dt> |
