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 11150
73d80859079c
parent 10684
58c7f23ae1cb
equal deleted inserted replaced
11149:fc45672fae42 11150:73d80859079c
40 <p> 40 <p>
41 Class implementing a checker for documentation string conventions. 41 Class implementing a checker for documentation string conventions.
42 </p> 42 </p>
43 43
44 <h3>Derived from</h3> 44 <h3>Derived from</h3>
45 None 45 CodeStyleTopicChecker
46 <h3>Class Attributes</h3> 46 <h3>Class Attributes</h3>
47 <table> 47 <table>
48 <tr><td>Category</td></tr>
48 <tr><td>Codes</td></tr> 49 <tr><td>Codes</td></tr>
49 </table> 50 </table>
50 51
51 <h3>Class Methods</h3> 52 <h3>Class Methods</h3>
52 <table> 53 <table>
178 <tr> 179 <tr>
179 <td><a href="#DocStyleChecker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td> 180 <td><a href="#DocStyleChecker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td>
180 <td>Private method to check, that all docstrings are surrounded by triple double quotes.</td> 181 <td>Private method to check, that all docstrings are surrounded by triple double quotes.</td>
181 </tr> 182 </tr>
182 <tr> 183 <tr>
183 <td><a href="#DocStyleChecker.__error">__error</a></td>
184 <td>Private method to record an issue.</td>
185 </tr>
186 <tr>
187 <td><a href="#DocStyleChecker.__getArgNames">__getArgNames</a></td> 184 <td><a href="#DocStyleChecker.__getArgNames">__getArgNames</a></td>
188 <td>Private method to get the argument names of a function node.</td> 185 <td>Private method to get the argument names of a function node.</td>
189 </tr> 186 </tr>
190 <tr> 187 <tr>
191 <td><a href="#DocStyleChecker.__getSummaryLine">__getSummaryLine</a></td> 188 <td><a href="#DocStyleChecker.__getSummaryLine">__getSummaryLine</a></td>
194 <tr> 191 <tr>
195 <td><a href="#DocStyleChecker.__getSummaryLines">__getSummaryLines</a></td> 192 <td><a href="#DocStyleChecker.__getSummaryLines">__getSummaryLines</a></td>
196 <td>Private method to extract the summary lines.</td> 193 <td>Private method to extract the summary lines.</td>
197 </tr> 194 </tr>
198 <tr> 195 <tr>
199 <td><a href="#DocStyleChecker.__ignoreCode">__ignoreCode</a></td>
200 <td>Private method to check if the error code should be ignored.</td>
201 </tr>
202 <tr>
203 <td><a href="#DocStyleChecker.__parseClasses">__parseClasses</a></td> 196 <td><a href="#DocStyleChecker.__parseClasses">__parseClasses</a></td>
204 <td>Private method to extract top-level classes.</td> 197 <td>Private method to extract top-level classes.</td>
205 </tr> 198 </tr>
206 <tr> 199 <tr>
207 <td><a href="#DocStyleChecker.__parseContexts">__parseContexts</a></td> 200 <td><a href="#DocStyleChecker.__parseContexts">__parseContexts</a></td>
236 <td>Private method to reset the internal readline function.</td> 229 <td>Private method to reset the internal readline function.</td>
237 </tr> 230 </tr>
238 <tr> 231 <tr>
239 <td><a href="#DocStyleChecker.__skipIndentedBlock">__skipIndentedBlock</a></td> 232 <td><a href="#DocStyleChecker.__skipIndentedBlock">__skipIndentedBlock</a></td>
240 <td>Private method to skip over an indented block of source code.</td> 233 <td>Private method to skip over an indented block of source code.</td>
234 </tr>
235 <tr>
236 <td><a href="#DocStyleChecker.addError">addError</a></td>
237 <td>Public method to record an issue.</td>
241 </tr> 238 </tr>
242 <tr> 239 <tr>
243 <td><a href="#DocStyleChecker.run">run</a></td> 240 <td><a href="#DocStyleChecker.run">run</a></td>
244 <td>Public method to check the given source for violations of doc string conventions.</td> 241 <td>Public method to check the given source for violations of doc string conventions.</td>
245 </tr> 242 </tr>
863 <dt><i>_context</i> (DocStyleContext)</dt> 860 <dt><i>_context</i> (DocStyleContext)</dt>
864 <dd> 861 <dd>
865 context of the docstring (unused) 862 context of the docstring (unused)
866 </dd> 863 </dd>
867 </dl> 864 </dl>
868 <a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a>
869 <h4>DocStyleChecker.__error</h4>
870 <b>__error</b>(<i>lineNumber, offset, code, *args</i>)
871 <p>
872 Private method to record an issue.
873 </p>
874
875 <dl>
876
877 <dt><i>lineNumber</i> (int)</dt>
878 <dd>
879 line number of the issue
880 </dd>
881 <dt><i>offset</i> (int)</dt>
882 <dd>
883 position within line of the issue
884 </dd>
885 <dt><i>code</i> (str)</dt>
886 <dd>
887 message code
888 </dd>
889 <dt><i>args</i> (list)</dt>
890 <dd>
891 arguments for the message
892 </dd>
893 </dl>
894 <a NAME="DocStyleChecker.__getArgNames" ID="DocStyleChecker.__getArgNames"></a> 865 <a NAME="DocStyleChecker.__getArgNames" ID="DocStyleChecker.__getArgNames"></a>
895 <h4>DocStyleChecker.__getArgNames</h4> 866 <h4>DocStyleChecker.__getArgNames</h4>
896 <b>__getArgNames</b>(<i>node</i>) 867 <b>__getArgNames</b>(<i>node</i>)
897 <p> 868 <p>
898 Private method to get the argument names of a function node. 869 Private method to get the argument names of a function node.
968 <dt>Return Type:</dt> 939 <dt>Return Type:</dt>
969 <dd> 940 <dd>
970 int 941 int
971 </dd> 942 </dd>
972 </dl> 943 </dl>
973 <a NAME="DocStyleChecker.__ignoreCode" ID="DocStyleChecker.__ignoreCode"></a>
974 <h4>DocStyleChecker.__ignoreCode</h4>
975 <b>__ignoreCode</b>(<i>code</i>)
976 <p>
977 Private method to check if the error code should be ignored.
978 </p>
979
980 <dl>
981
982 <dt><i>code</i> (str)</dt>
983 <dd>
984 message code to check for
985 </dd>
986 </dl>
987 <dl>
988 <dt>Return:</dt>
989 <dd>
990 flag indicating to ignore the given code
991 </dd>
992 </dl>
993 <dl>
994 <dt>Return Type:</dt>
995 <dd>
996 bool
997 </dd>
998 </dl>
999 <a NAME="DocStyleChecker.__parseClasses" ID="DocStyleChecker.__parseClasses"></a> 944 <a NAME="DocStyleChecker.__parseClasses" ID="DocStyleChecker.__parseClasses"></a>
1000 <h4>DocStyleChecker.__parseClasses</h4> 945 <h4>DocStyleChecker.__parseClasses</h4>
1001 <b>__parseClasses</b>(<i></i>) 946 <b>__parseClasses</b>(<i></i>)
1002 <p> 947 <p>
1003 Private method to extract top-level classes. 948 Private method to extract top-level classes.
1209 </dl> 1154 </dl>
1210 <dl> 1155 <dl>
1211 <dt>Return Type:</dt> 1156 <dt>Return Type:</dt>
1212 <dd> 1157 <dd>
1213 tuple 1158 tuple
1159 </dd>
1160 </dl>
1161 <a NAME="DocStyleChecker.addError" ID="DocStyleChecker.addError"></a>
1162 <h4>DocStyleChecker.addError</h4>
1163 <b>addError</b>(<i>lineNumber, offset, msgCode, *args</i>)
1164 <p>
1165 Public method to record an issue.
1166 </p>
1167
1168 <dl>
1169
1170 <dt><i>lineNumber</i> (int)</dt>
1171 <dd>
1172 line number of the issue (zero based)
1173 </dd>
1174 <dt><i>offset</i> (int)</dt>
1175 <dd>
1176 position within line of the issue
1177 </dd>
1178 <dt><i>msgCode</i> (str)</dt>
1179 <dd>
1180 message code
1181 </dd>
1182 <dt><i>args</i> (list)</dt>
1183 <dd>
1184 arguments for the message
1214 </dd> 1185 </dd>
1215 </dl> 1186 </dl>
1216 <a NAME="DocStyleChecker.run" ID="DocStyleChecker.run"></a> 1187 <a NAME="DocStyleChecker.run" ID="DocStyleChecker.run"></a>
1217 <h4>DocStyleChecker.run</h4> 1188 <h4>DocStyleChecker.run</h4>
1218 <b>run</b>(<i></i>) 1189 <b>run</b>(<i></i>)

Mercurial Repository: eric

eric ide

mercurial