diff -r 4dd53711d869 -r 04a671fa4adb Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html
--- a/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html Sat Apr 21 17:11:05 2018 +0200
+++ b/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html Sat Apr 21 17:43:41 2018 +0200
@@ -44,7 +44,7 @@
<td>Module function to check code style for a batch of files.</td>
</tr><tr>
<td><a href="#codeStyleCheck">codeStyleCheck</a></td>
-<td>Do the code style check and/ or fix found errors.</td>
+<td>Do the code style check and/or fix found errors.</td>
</tr><tr>
<td><a href="#extractLineFlags">extractLineFlags</a></td>
<td>Function to extract flags starting and ending with '__' from a line comment.</td>
@@ -139,28 +139,33 @@
Private module function to perform the code style check and/or fix
found errors.
</p><dl>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
-source filename (string)
-</dd><dt><i>source</i></dt>
+source filename
+</dd><dt><i>source</i> (str)</dt>
<dd>
-string containing the code to check (string)
-</dd><dt><i>args</i></dt>
+string containing the code to check
+</dd><dt><i>args</i> (list of (str, str, bool, str, str, bool, int, list of (int, int),)</dt>
<dd>
arguments used by the codeStyleCheck function (list of
- excludeMessages (str), includeMessages (str), repeatMessages
- (bool), fixCodes (str), noFixCodes (str), fixIssues (bool),
- maxLineLength (int), hangClosing (bool), docType (str), dictionary
- with arguments for the code complexity checker (dict), dictionary
- with arguments for the miscellaneous checker (dict), errors (list
- of str), eol (str), encoding (str), backup (bool))
+ excludeMessages, includeMessages, repeatMessages, fixCodes,
+ noFixCodes, fixIssues, maxLineLength, blankLines, hangClosing,
+ docType, codeComplexityArgs, miscellaneousArgs, errors, eol,
+ encoding, backup)
+ bool, str, dict, dict, list of str, str, str, bool)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-tuple of statistics (dict) and results (tuple for each found
- violation of style (tuple of lineno (int), position (int), text (str),
- ignored (bool), fixed (bool), autofixing (bool), fixedMsg (str)))
+tuple of statistics (dict) and list of results (tuple for each
+ found violation of style (lineno, position, text, ignored, fixed,
+ autofixing, fixedMsg))
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (dict, list of tuples of (int, int, str, bool, bool, bool,
+ str))
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -194,28 +199,35 @@
<h2>codeStyleCheck</h2>
<b>codeStyleCheck</b>(<i>filename, source, args</i>)
<p>
- Do the code style check and/ or fix found errors.
+ Do the code style check and/or fix found errors.
</p><dl>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
-source filename (string)
-</dd><dt><i>source</i></dt>
+source filename
+</dd><dt><i>source</i> (str)</dt>
<dd>
-string containing the code to check (string)
-</dd><dt><i>args</i></dt>
+string containing the code to check
+</dd><dt><i>args</i> (list of (str, str, bool, str, str, bool, int, list of (int, int),)</dt>
<dd>
arguments used by the codeStyleCheck function (list of
- excludeMessages (str), includeMessages (str), repeatMessages
- (bool), fixCodes (str), noFixCodes (str), fixIssues (bool),
- maxLineLength (int), hangClosing (bool), docType (str), errors
- (list of str), eol (str), encoding (str), backup (bool))
+ excludeMessages, includeMessages, repeatMessages, fixCodes,
+ noFixCodes, fixIssues, maxLineLength, blankLines, hangClosing,
+ docType, codeComplexityArgs, miscellaneousArgs, errors, eol,
+ encoding, backup)
+ bool, str, dict, dict, list of str, str, str, bool)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-tuple of stats (dict) and results (tuple for each found violation
- of style (tuple of lineno (int), position (int), text (str), ignored
- (bool), fixed (bool), autofixing (bool), fixedMsg (str)))
+tuple of statistics (dict) and list of results (tuple for each
+ found violation of style (lineno, position, text, ignored, fixed,
+ autofixing, fixedMsg))
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (dict, list of tuples of (int, int, str, bool, bool, bool,
+ str))
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
