Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Plugins.PluginCodeStyleChecker.html

Documentation/Source/eric6.Plugins.PluginCodeStyleChecker.html

changeset 4218
f542ad1f76c5
parent 3673
e26d7d0c1088
child 4222
1db92cbf62c9
equal deleted inserted replaced
4217:38e8903f9c2f 4218:f542ad1f76c5
43 <h2>CodeStyleCheckerPlugin</h2> 43 <h2>CodeStyleCheckerPlugin</h2>
44 <p> 44 <p>
45 Class implementing the code style checker plug-in. 45 Class implementing the code style checker plug-in.
46 </p><h3>Signals</h3> 46 </p><h3>Signals</h3>
47 <dl> 47 <dl>
48 <dt>styleChecked(str, dict, int, list)</dt> 48 <dt>batchFinished()</dt>
49 <dd> 49 <dd>
50 emited when the style check was 50 emitted when a style check batch is done
51 done. 51 </dd><dt>styleChecked(str, dict, int, list)</dt>
52 <dd>
53 emitted when the style check was
54 done for a file.
52 </dd> 55 </dd>
53 </dl> 56 </dl>
54 <h3>Derived from</h3> 57 <h3>Derived from</h3>
55 QObject 58 QObject
56 <h3>Class Attributes</h3> 59 <h3>Class Attributes</h3>
101 <td>Private slot called after perfoming a style check on one file.</td> 104 <td>Private slot called after perfoming a style check on one file.</td>
102 </tr><tr> 105 </tr><tr>
103 <td><a href="#CodeStyleCheckerPlugin.activate">activate</a></td> 106 <td><a href="#CodeStyleCheckerPlugin.activate">activate</a></td>
104 <td>Public method to activate this plugin.</td> 107 <td>Public method to activate this plugin.</td>
105 </tr><tr> 108 </tr><tr>
109 <td><a href="#CodeStyleCheckerPlugin.batchJobDone">batchJobDone</a></td>
110 <td>Public slot handling the completion of a batch job.</td>
111 </tr><tr>
106 <td><a href="#CodeStyleCheckerPlugin.deactivate">deactivate</a></td> 112 <td><a href="#CodeStyleCheckerPlugin.deactivate">deactivate</a></td>
107 <td>Public method to deactivate this plugin.</td> 113 <td>Public method to deactivate this plugin.</td>
108 </tr><tr> 114 </tr><tr>
109 <td><a href="#CodeStyleCheckerPlugin.serviceErrorPy2">serviceErrorPy2</a></td> 115 <td><a href="#CodeStyleCheckerPlugin.serviceErrorPy2">serviceErrorPy2</a></td>
110 <td>Public method handling service errors for Python 2.</td> 116 <td>Public slot handling service errors for Python 2.</td>
111 </tr><tr> 117 </tr><tr>
112 <td><a href="#CodeStyleCheckerPlugin.serviceErrorPy3">serviceErrorPy3</a></td> 118 <td><a href="#CodeStyleCheckerPlugin.serviceErrorPy3">serviceErrorPy3</a></td>
113 <td>Public method handling service errors for Python 2.</td> 119 <td>Public slot handling service errors for Python 2.</td>
120 </tr><tr>
121 <td><a href="#CodeStyleCheckerPlugin.styleBatchCheck">styleBatchCheck</a></td>
122 <td>Public method to prepare a style check on multiple Python source files.</td>
114 </tr><tr> 123 </tr><tr>
115 <td><a href="#CodeStyleCheckerPlugin.styleCheck">styleCheck</a></td> 124 <td><a href="#CodeStyleCheckerPlugin.styleCheck">styleCheck</a></td>
116 <td>Public method to prepare a style check on one Python source file.</td> 125 <td>Public method to prepare a style check on one Python source file.</td>
117 </tr> 126 </tr>
118 </table> 127 </table>
256 </p><dl> 265 </p><dl>
257 <dt>Returns:</dt> 266 <dt>Returns:</dt>
258 <dd> 267 <dd>
259 tuple of None and activation status (boolean) 268 tuple of None and activation status (boolean)
260 </dd> 269 </dd>
270 </dl><a NAME="CodeStyleCheckerPlugin.batchJobDone" ID="CodeStyleCheckerPlugin.batchJobDone"></a>
271 <h4>CodeStyleCheckerPlugin.batchJobDone</h4>
272 <b>batchJobDone</b>(<i>fx, lang</i>)
273 <p>
274 Public slot handling the completion of a batch job.
275 </p><dl>
276 <dt><i>fx</i></dt>
277 <dd>
278 service name (string)
279 </dd><dt><i>lang</i></dt>
280 <dd>
281 language (string)
282 </dd>
261 </dl><a NAME="CodeStyleCheckerPlugin.deactivate" ID="CodeStyleCheckerPlugin.deactivate"></a> 283 </dl><a NAME="CodeStyleCheckerPlugin.deactivate" ID="CodeStyleCheckerPlugin.deactivate"></a>
262 <h4>CodeStyleCheckerPlugin.deactivate</h4> 284 <h4>CodeStyleCheckerPlugin.deactivate</h4>
263 <b>deactivate</b>(<i></i>) 285 <b>deactivate</b>(<i></i>)
264 <p> 286 <p>
265 Public method to deactivate this plugin. 287 Public method to deactivate this plugin.
266 </p><a NAME="CodeStyleCheckerPlugin.serviceErrorPy2" ID="CodeStyleCheckerPlugin.serviceErrorPy2"></a> 288 </p><a NAME="CodeStyleCheckerPlugin.serviceErrorPy2" ID="CodeStyleCheckerPlugin.serviceErrorPy2"></a>
267 <h4>CodeStyleCheckerPlugin.serviceErrorPy2</h4> 289 <h4>CodeStyleCheckerPlugin.serviceErrorPy2</h4>
268 <b>serviceErrorPy2</b>(<i>fx, lang, fn, msg</i>) 290 <b>serviceErrorPy2</b>(<i>fx, lang, fn, msg</i>)
269 <p> 291 <p>
270 Public method handling service errors for Python 2. 292 Public slot handling service errors for Python 2.
271 </p><dl> 293 </p><dl>
272 <dt><i>fx</i></dt> 294 <dt><i>fx</i></dt>
273 <dd> 295 <dd>
274 service name (string) 296 service name (string)
275 </dd><dt><i>lang</i></dt> 297 </dd><dt><i>lang</i></dt>
284 </dd> 306 </dd>
285 </dl><a NAME="CodeStyleCheckerPlugin.serviceErrorPy3" ID="CodeStyleCheckerPlugin.serviceErrorPy3"></a> 307 </dl><a NAME="CodeStyleCheckerPlugin.serviceErrorPy3" ID="CodeStyleCheckerPlugin.serviceErrorPy3"></a>
286 <h4>CodeStyleCheckerPlugin.serviceErrorPy3</h4> 308 <h4>CodeStyleCheckerPlugin.serviceErrorPy3</h4>
287 <b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>) 309 <b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>)
288 <p> 310 <p>
289 Public method handling service errors for Python 2. 311 Public slot handling service errors for Python 2.
290 </p><dl> 312 </p><dl>
291 <dt><i>fx</i></dt> 313 <dt><i>fx</i></dt>
292 <dd> 314 <dd>
293 service name (string) 315 service name (string)
294 </dd><dt><i>lang</i></dt> 316 </dd><dt><i>lang</i></dt>
298 <dd> 320 <dd>
299 file name (string) 321 file name (string)
300 </dd><dt><i>msg</i></dt> 322 </dd><dt><i>msg</i></dt>
301 <dd> 323 <dd>
302 message text (string) 324 message text (string)
325 </dd>
326 </dl><a NAME="CodeStyleCheckerPlugin.styleBatchCheck" ID="CodeStyleCheckerPlugin.styleBatchCheck"></a>
327 <h4>CodeStyleCheckerPlugin.styleBatchCheck</h4>
328 <b>styleBatchCheck</b>(<i>argumentsList</i>)
329 <p>
330 Public method to prepare a style check on multiple Python source files.
331 </p><dl>
332 <dt><i>argumentsList</i></dt>
333 <dd>
334 list of arguments tuples with each tuple
335 containing filename, source and args as given in styleCheck()
336 method
303 </dd> 337 </dd>
304 </dl><a NAME="CodeStyleCheckerPlugin.styleCheck" ID="CodeStyleCheckerPlugin.styleCheck"></a> 338 </dl><a NAME="CodeStyleCheckerPlugin.styleCheck" ID="CodeStyleCheckerPlugin.styleCheck"></a>
305 <h4>CodeStyleCheckerPlugin.styleCheck</h4> 339 <h4>CodeStyleCheckerPlugin.styleCheck</h4>
306 <b>styleCheck</b>(<i>lang, filename, source, args</i>) 340 <b>styleCheck</b>(<i>lang, filename, source, args</i>)
307 <p> 341 <p>

Mercurial Repository: eric

eric ide

mercurial