Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html

changeset 2985
177b1858245f
child 3171
2c37b9a37b2d
child 3209
c5432abceb25
equal deleted inserted replaced
2984:031cceaa8b01 2985:177b1858245f
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric5.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric5.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker</h1>
23 <p>
24 Module implementing the code style checker.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#CodeStyleCheckerPy2">CodeStyleCheckerPy2</a></td>
34 <td>Class implementing the code style checker interface for Python 2.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="CodeStyleCheckerPy2" ID="CodeStyleCheckerPy2"></a>
43 <h2>CodeStyleCheckerPy2</h2>
44 <p>
45 Class implementing the code style checker interface for Python 2.
46 </p>
47 <h3>Derived from</h3>
48 object
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#CodeStyleCheckerPy2.__init__">CodeStyleCheckerPy2</a></td>
61 <td>Constructor</td>
62 </tr>
63 </table>
64 <h3>Static Methods</h3>
65 <table>
66 <tr><td>None</td></tr>
67 </table>
68 <a NAME="CodeStyleCheckerPy2.__init__" ID="CodeStyleCheckerPy2.__init__"></a>
69 <h4>CodeStyleCheckerPy2 (Constructor)</h4>
70 <b>CodeStyleCheckerPy2</b>(<i>filename, lines, repeat=False, select="", ignore="", max_line_length=79, hang_closing=False, docType="pep257"</i>)
71 <p>
72 Constructor
73 </p><dl>
74 <dt><i>filename</i></dt>
75 <dd>
76 name of the file to check (string)
77 </dd><dt><i>lines</i></dt>
78 <dd>
79 source of the file (list of strings) (ignored)
80 </dd><dt><i>repeat=</i></dt>
81 <dd>
82 flag indicating to repeat message categories (boolean)
83 </dd><dt><i>select=</i></dt>
84 <dd>
85 list of message IDs to check for
86 (comma separated string)
87 </dd><dt><i>ignore=</i></dt>
88 <dd>
89 list of message IDs to ignore
90 (comma separated string)
91 </dd><dt><i>max_line_length=</i></dt>
92 <dd>
93 maximum allowed line length (integer)
94 </dd><dt><i>hang_closing=</i></dt>
95 <dd>
96 flag indicating to allow hanging closing
97 brackets (boolean)
98 </dd><dt><i>docType=</i></dt>
99 <dd>
100 type of the documentation strings
101 (string, one of 'eric' or 'pep257')
102 </dd>
103 </dl>
104 <div align="right"><a href="#top">Up</a></div>
105 <hr />
106 </body></html>

eric ide

mercurial