--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html Sat Aug 24 14:44:55 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html Sat Aug 24 15:05:05 2013 +0200 @@ -32,6 +32,9 @@ <tr> <td><a href="#Pep8Dialog">Pep8Dialog</a></td> <td>Class implementing a dialog to show the results of the PEP 8 check.</td> +</tr><tr> +<td><a href="#Pep8Report">Pep8Report</a></td> +<td>Class implementing a special report to be used with our dialog.</td> </tr> </table> <h3>Functions</h3> @@ -287,5 +290,69 @@ </dd> </dl> <div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="Pep8Report" ID="Pep8Report"></a> +<h2>Pep8Report</h2> +<p> + Class implementing a special report to be used with our dialog. +</p> +<h3>Derived from</h3> +pep8.BaseReport +<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="#Pep8Report.__init__">Pep8Report</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#Pep8Report.error_args">error_args</a></td> +<td>Public method to collect the error messages.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="Pep8Report.__init__" ID="Pep8Report.__init__"></a> +<h4>Pep8Report (Constructor)</h4> +<b>Pep8Report</b>(<i>options</i>) +<p> + Constructor +</p><dl> +<dt><i>options</i></dt> +<dd> +options for the report (optparse.Values) +</dd> +</dl><a NAME="Pep8Report.error_args" ID="Pep8Report.error_args"></a> +<h4>Pep8Report.error_args</h4> +<b>error_args</b>(<i>line_number, offset, code, check, *args</i>) +<p> + Public method to collect the error messages. +</p><dl> +<dt><i>line_number</i></dt> +<dd> +line number of the issue (integer) +</dd><dt><i>offset</i></dt> +<dd> +position within line of the issue (integer) +</dd><dt><i>code</i></dt> +<dd> +message code (string) +</dd><dt><i>check</i></dt> +<dd> +reference to the checker function (function) +</dd><dt><i>args</i></dt> +<dd> +arguments for the message (list) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file