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

changeset 2985
177b1858245f
child 3171
2c37b9a37b2d
child 3209
c5432abceb25
diff -r 031cceaa8b01 -r 177b1858245f Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html	Fri Oct 04 17:48:17 2013 +0200
@@ -0,0 +1,106 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric5.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker</h1>
+<p>
+Module implementing the code style checker.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#CodeStyleCheckerPy2">CodeStyleCheckerPy2</a></td>
+<td>Class implementing the code style checker interface for Python 2.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="CodeStyleCheckerPy2" ID="CodeStyleCheckerPy2"></a>
+<h2>CodeStyleCheckerPy2</h2>
+<p>
+    Class implementing the code style checker interface for Python 2.
+</p>
+<h3>Derived from</h3>
+object
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#CodeStyleCheckerPy2.__init__">CodeStyleCheckerPy2</a></td>
+<td>Constructor</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="CodeStyleCheckerPy2.__init__" ID="CodeStyleCheckerPy2.__init__"></a>
+<h4>CodeStyleCheckerPy2 (Constructor)</h4>
+<b>CodeStyleCheckerPy2</b>(<i>filename, lines, repeat=False, select="", ignore="", max_line_length=79, hang_closing=False, docType="pep257"</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>filename</i></dt>
+<dd>
+name of the file to check (string)
+</dd><dt><i>lines</i></dt>
+<dd>
+source of the file (list of strings) (ignored)
+</dd><dt><i>repeat=</i></dt>
+<dd>
+flag indicating to repeat message categories (boolean)
+</dd><dt><i>select=</i></dt>
+<dd>
+list of message IDs to check for
+            (comma separated string)
+</dd><dt><i>ignore=</i></dt>
+<dd>
+list of message IDs to ignore
+            (comma separated string)
+</dd><dt><i>max_line_length=</i></dt>
+<dd>
+maximum allowed line length (integer)
+</dd><dt><i>hang_closing=</i></dt>
+<dd>
+flag indicating to allow hanging closing
+            brackets (boolean)
+</dd><dt><i>docType=</i></dt>
+<dd>
+type of the documentation strings
+            (string, one of 'eric' or 'pep257')
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial