Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html
Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html
- changeset 3083
- 6382a74d9599
- parent 2985
- 177b1858245f
- child 3165
- 400234200cd6
- child 3209
- c5432abceb25
equal
deleted
inserted
replaced
| 3081:d50cc9efc7c7 | 3083:6382a74d9599 |
|---|---|
| 23 <p> | 23 <p> |
| 24 Module implementing a checker for documentation string conventions. | 24 Module implementing a checker for documentation string conventions. |
| 25 </p> | 25 </p> |
| 26 <h3>Global Attributes</h3> | 26 <h3>Global Attributes</h3> |
| 27 <table> | 27 <table> |
| 28 <tr><td>None</td></tr> | 28 <tr><td>PyCF_ONLY_AST</td></tr> |
| 29 </table> | 29 </table> |
| 30 <h3>Classes</h3> | 30 <h3>Classes</h3> |
| 31 <table> | 31 <table> |
| 32 <tr> | 32 <tr> |
| 33 <td><a href="#DocStyleChecker">DocStyleChecker</a></td> | 33 <td><a href="#DocStyleChecker">DocStyleChecker</a></td> |
| 49 </p> | 49 </p> |
| 50 <h3>Derived from</h3> | 50 <h3>Derived from</h3> |
| 51 object | 51 object |
| 52 <h3>Class Attributes</h3> | 52 <h3>Class Attributes</h3> |
| 53 <table> | 53 <table> |
| 54 <tr><td>Codes</td></tr><tr><td>Messages</td></tr> | 54 <tr><td>Codes</td></tr><tr><td>Messages</td></tr><tr><td>MessagesSampleArgs</td></tr> |
| 55 </table> | 55 </table> |
| 56 <h3>Class Methods</h3> | 56 <h3>Class Methods</h3> |
| 57 <table> | 57 <table> |
| 58 <tr> | 58 <tr> |
| 59 <td><a href="#DocStyleChecker.getMessage">getMessage</a></td> | 59 <td><a href="#DocStyleChecker.getMessage">getMessage</a></td> |
| 174 <td><a href="#DocStyleChecker.__parseTopLevel">__parseTopLevel</a></td> | 174 <td><a href="#DocStyleChecker.__parseTopLevel">__parseTopLevel</a></td> |
| 175 <td>Private method to extract top-level functions or classes.</td> | 175 <td>Private method to extract top-level functions or classes.</td> |
| 176 </tr><tr> | 176 </tr><tr> |
| 177 <td><a href="#DocStyleChecker.__readline">__readline</a></td> | 177 <td><a href="#DocStyleChecker.__readline">__readline</a></td> |
| 178 <td>Private method to get the next line from the source.</td> | 178 <td>Private method to get the next line from the source.</td> |
| 179 </tr><tr> | |
| 180 <td><a href="#DocStyleChecker.__reportInvalidSyntax">__reportInvalidSyntax</a></td> | |
| 181 <td>Private method to report a syntax error.</td> | |
| 179 </tr><tr> | 182 </tr><tr> |
| 180 <td><a href="#DocStyleChecker.__resetReadline">__resetReadline</a></td> | 183 <td><a href="#DocStyleChecker.__resetReadline">__resetReadline</a></td> |
| 181 <td>Private method to reset the internal readline function.</td> | 184 <td>Private method to reset the internal readline function.</td> |
| 182 </tr><tr> | 185 </tr><tr> |
| 183 <td><a href="#DocStyleChecker.__skipIndentedBlock">__skipIndentedBlock</a></td> | 186 <td><a href="#DocStyleChecker.__skipIndentedBlock">__skipIndentedBlock</a></td> |
| 746 </p><dl> | 749 </p><dl> |
| 747 <dt>Returns:</dt> | 750 <dt>Returns:</dt> |
| 748 <dd> | 751 <dd> |
| 749 next line of source (string) | 752 next line of source (string) |
| 750 </dd> | 753 </dd> |
| 751 </dl><a NAME="DocStyleChecker.__resetReadline" ID="DocStyleChecker.__resetReadline"></a> | 754 </dl><a NAME="DocStyleChecker.__reportInvalidSyntax" ID="DocStyleChecker.__reportInvalidSyntax"></a> |
| 755 <h4>DocStyleChecker.__reportInvalidSyntax</h4> | |
| 756 <b>__reportInvalidSyntax</b>(<i></i>) | |
| 757 <p> | |
| 758 Private method to report a syntax error. | |
| 759 </p><a NAME="DocStyleChecker.__resetReadline" ID="DocStyleChecker.__resetReadline"></a> | |
| 752 <h4>DocStyleChecker.__resetReadline</h4> | 760 <h4>DocStyleChecker.__resetReadline</h4> |
| 753 <b>__resetReadline</b>(<i></i>) | 761 <b>__resetReadline</b>(<i></i>) |
| 754 <p> | 762 <p> |
| 755 Private method to reset the internal readline function. | 763 Private method to reset the internal readline function. |
| 756 </p><a NAME="DocStyleChecker.__skipIndentedBlock" ID="DocStyleChecker.__skipIndentedBlock"></a> | 764 </p><a NAME="DocStyleChecker.__skipIndentedBlock" ID="DocStyleChecker.__skipIndentedBlock"></a> |
