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

branch
Py2 comp.
changeset 3456
96232974dcdb
parent 3209
c5432abceb25
child 3549
96ebf42cd960
--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html	Sun Jan 05 23:22:17 2014 +0100
+++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html	Sun Mar 30 22:00:14 2014 +0200
@@ -54,7 +54,7 @@
     Class implementing a fixer for certain code style issues.
 </p>
 <h3>Derived from</h3>
-QObject
+object
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
@@ -81,9 +81,6 @@
 <td><a href="#CodeStyleFixer.__fixD112">__fixD112</a></td>
 <td>Private method to fix docstring 'r' or 'u' in leading quotes.</td>
 </tr><tr>
-<td><a href="#CodeStyleFixer.__fixD121">__fixD121</a></td>
-<td>Private method to fix a single line docstring on multiple lines.</td>
-</tr><tr>
 <td><a href="#CodeStyleFixer.__fixD131">__fixD131</a></td>
 <td>Private method to fix a docstring summary not ending with a period.</td>
 </tr><tr>
@@ -204,9 +201,6 @@
 <td><a href="#CodeStyleFixer.__fixWhitespace">__fixWhitespace</a></td>
 <td>Private method to correct whitespace at the given offset.</td>
 </tr><tr>
-<td><a href="#CodeStyleFixer.__getEol">__getEol</a></td>
-<td>Private method to get the applicable eol string.</td>
-</tr><tr>
 <td><a href="#CodeStyleFixer.__getID">__getID</a></td>
 <td>Private method to get the ID for a deferred fix.</td>
 </tr><tr>
@@ -241,14 +235,11 @@
 </table>
 <a NAME="CodeStyleFixer.__init__" ID="CodeStyleFixer.__init__"></a>
 <h4>CodeStyleFixer (Constructor)</h4>
-<b>CodeStyleFixer</b>(<i>project, filename, sourceLines, fixCodes, noFixCodes, maxLineLength, inPlace</i>)
+<b>CodeStyleFixer</b>(<i>filename, sourceLines, fixCodes, noFixCodes, maxLineLength, inPlace, eol</i>)
 <p>
         Constructor
 </p><dl>
-<dt><i>project</i></dt>
-<dd>
-reference to the project object (Project)
-</dd><dt><i>filename</i></dt>
+<dt><i>filename</i></dt>
 <dd>
 name of the file to be fixed (string)
 </dd><dt><i>sourceLines</i></dt>
@@ -269,6 +260,9 @@
 </dd><dt><i>inPlace</i></dt>
 <dd>
 flag indicating to modify the file in place (boolean)
+</dd><dt><i>eol</i></dt>
+<dd>
+end of line character(s) (string)
 </dd>
 </dl><a NAME="CodeStyleFixer.__codeMatch" ID="CodeStyleFixer.__codeMatch"></a>
 <h4>CodeStyleFixer.__codeMatch</h4>
@@ -347,35 +341,6 @@
             a message for the fix (string) and an ID for a deferred
             fix (integer)
 </dd>
-</dl><a NAME="CodeStyleFixer.__fixD121" ID="CodeStyleFixer.__fixD121"></a>
-<h4>CodeStyleFixer.__fixD121</h4>
-<b>__fixD121</b>(<i>code, line, pos, apply=False</i>)
-<p>
-        Private method to fix a single line docstring on multiple lines.
-</p><p>
-        Codes: D121
-</p><dl>
-<dt><i>code</i></dt>
-<dd>
-code of the issue (string)
-</dd><dt><i>line</i></dt>
-<dd>
-line number of the issue (integer)
-</dd><dt><i>pos</i></dt>
-<dd>
-position inside line (integer)
-</dd><dt><i>apply=</i></dt>
-<dd>
-flag indicating, that the fix should be applied
-            (boolean)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-value indicating an applied/deferred fix (-1, 0, 1),
-            a message for the fix (string) and an ID for a deferred
-            fix (integer)
-</dd>
 </dl><a NAME="CodeStyleFixer.__fixD131" ID="CodeStyleFixer.__fixD131"></a>
 <h4>CodeStyleFixer.__fixD131</h4>
 <b>__fixD131</b>(<i>code, line, pos</i>)
@@ -1488,16 +1453,6 @@
 <dd>
 corrected line
 </dd>
-</dl><a NAME="CodeStyleFixer.__getEol" ID="CodeStyleFixer.__getEol"></a>
-<h4>CodeStyleFixer.__getEol</h4>
-<b>__getEol</b>(<i></i>)
-<p>
-        Private method to get the applicable eol string.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-eol string (string)
-</dd>
 </dl><a NAME="CodeStyleFixer.__getID" ID="CodeStyleFixer.__getID"></a>
 <h4>CodeStyleFixer.__getID</h4>
 <b>__getID</b>(<i></i>)
@@ -1626,7 +1581,7 @@
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating success (boolean)
+error message on failure (tuple of str)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial