Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Logging.LoggingChecker.html
src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Logging.LoggingChecker.html
- branch
- eric7
- changeset 11150
- 73d80859079c
- parent 10479
- 856476537696
equal
deleted
inserted
replaced
| 11149:fc45672fae42 | 11150:73d80859079c |
|---|---|
| 36 <p> | 36 <p> |
| 37 Class implementing a checker for logging related issues. | 37 Class implementing a checker for logging related issues. |
| 38 </p> | 38 </p> |
| 39 | 39 |
| 40 <h3>Derived from</h3> | 40 <h3>Derived from</h3> |
| 41 None | 41 CodeStyleTopicChecker |
| 42 <h3>Class Attributes</h3> | 42 <h3>Class Attributes</h3> |
| 43 <table> | 43 <table> |
| 44 <tr><td>Category</td></tr> | |
| 44 <tr><td>Codes</td></tr> | 45 <tr><td>Codes</td></tr> |
| 45 </table> | 46 </table> |
| 46 | 47 |
| 47 <h3>Class Methods</h3> | 48 <h3>Class Methods</h3> |
| 48 <table> | 49 <table> |
| 56 <td>Constructor</td> | 57 <td>Constructor</td> |
| 57 </tr> | 58 </tr> |
| 58 <tr> | 59 <tr> |
| 59 <td><a href="#LoggingChecker.__checkLogging">__checkLogging</a></td> | 60 <td><a href="#LoggingChecker.__checkLogging">__checkLogging</a></td> |
| 60 <td>Private method to check logging statements.</td> | 61 <td>Private method to check logging statements.</td> |
| 61 </tr> | |
| 62 <tr> | |
| 63 <td><a href="#LoggingChecker.__error">__error</a></td> | |
| 64 <td>Private method to record an issue.</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#LoggingChecker.__ignoreCode">__ignoreCode</a></td> | |
| 68 <td>Private method to check if the message code should be ignored.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#LoggingChecker.run">run</a></td> | |
| 72 <td>Public method to check the given source against miscellaneous conditions.</td> | |
| 73 </tr> | 62 </tr> |
| 74 </table> | 63 </table> |
| 75 | 64 |
| 76 <h3>Static Methods</h3> | 65 <h3>Static Methods</h3> |
| 77 <table> | 66 <table> |
| 126 <b>__checkLogging</b>(<i></i>) | 115 <b>__checkLogging</b>(<i></i>) |
| 127 <p> | 116 <p> |
| 128 Private method to check logging statements. | 117 Private method to check logging statements. |
| 129 </p> | 118 </p> |
| 130 | 119 |
| 131 <a NAME="LoggingChecker.__error" ID="LoggingChecker.__error"></a> | |
| 132 <h4>LoggingChecker.__error</h4> | |
| 133 <b>__error</b>(<i>lineNumber, offset, code, *args</i>) | |
| 134 <p> | |
| 135 Private method to record an issue. | |
| 136 </p> | |
| 137 | |
| 138 <dl> | |
| 139 | |
| 140 <dt><i>lineNumber</i> (int)</dt> | |
| 141 <dd> | |
| 142 line number of the issue | |
| 143 </dd> | |
| 144 <dt><i>offset</i> (int)</dt> | |
| 145 <dd> | |
| 146 position within line of the issue | |
| 147 </dd> | |
| 148 <dt><i>code</i> (str)</dt> | |
| 149 <dd> | |
| 150 message code | |
| 151 </dd> | |
| 152 <dt><i>args</i> (list)</dt> | |
| 153 <dd> | |
| 154 arguments for the message | |
| 155 </dd> | |
| 156 </dl> | |
| 157 <a NAME="LoggingChecker.__ignoreCode" ID="LoggingChecker.__ignoreCode"></a> | |
| 158 <h4>LoggingChecker.__ignoreCode</h4> | |
| 159 <b>__ignoreCode</b>(<i>code</i>) | |
| 160 <p> | |
| 161 Private method to check if the message code should be ignored. | |
| 162 </p> | |
| 163 | |
| 164 <dl> | |
| 165 | |
| 166 <dt><i>code</i> (str)</dt> | |
| 167 <dd> | |
| 168 message code to check for | |
| 169 </dd> | |
| 170 </dl> | |
| 171 <dl> | |
| 172 <dt>Return:</dt> | |
| 173 <dd> | |
| 174 flag indicating to ignore the given code | |
| 175 </dd> | |
| 176 </dl> | |
| 177 <dl> | |
| 178 <dt>Return Type:</dt> | |
| 179 <dd> | |
| 180 bool | |
| 181 </dd> | |
| 182 </dl> | |
| 183 <a NAME="LoggingChecker.run" ID="LoggingChecker.run"></a> | |
| 184 <h4>LoggingChecker.run</h4> | |
| 185 <b>run</b>(<i></i>) | |
| 186 <p> | |
| 187 Public method to check the given source against miscellaneous | |
| 188 conditions. | |
| 189 </p> | |
| 190 | |
| 191 <div align="right"><a href="#top">Up</a></div> | 120 <div align="right"><a href="#top">Up</a></div> |
| 192 <hr /> | 121 <hr /> |
| 193 </body></html> | 122 </body></html> |
