diff -r fc45672fae42 -r 73d80859079c src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html --- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html Thu Feb 27 09:22:15 2025 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html Thu Feb 27 14:42:39 2025 +0100 @@ -42,9 +42,10 @@ </p> <h3>Derived from</h3> -None +CodeStyleTopicChecker <h3>Class Attributes</h3> <table> +<tr><td>Category</td></tr> <tr><td>Codes</td></tr> </table> @@ -180,10 +181,6 @@ <td>Private method to check, that all docstrings are surrounded by triple double quotes.</td> </tr> <tr> -<td><a href="#DocStyleChecker.__error">__error</a></td> -<td>Private method to record an issue.</td> -</tr> -<tr> <td><a href="#DocStyleChecker.__getArgNames">__getArgNames</a></td> <td>Private method to get the argument names of a function node.</td> </tr> @@ -196,10 +193,6 @@ <td>Private method to extract the summary lines.</td> </tr> <tr> -<td><a href="#DocStyleChecker.__ignoreCode">__ignoreCode</a></td> -<td>Private method to check if the error code should be ignored.</td> -</tr> -<tr> <td><a href="#DocStyleChecker.__parseClasses">__parseClasses</a></td> <td>Private method to extract top-level classes.</td> </tr> @@ -240,6 +233,10 @@ <td>Private method to skip over an indented block of source code.</td> </tr> <tr> +<td><a href="#DocStyleChecker.addError">addError</a></td> +<td>Public method to record an issue.</td> +</tr> +<tr> <td><a href="#DocStyleChecker.run">run</a></td> <td>Public method to check the given source for violations of doc string conventions.</td> </tr> @@ -865,32 +862,6 @@ context of the docstring (unused) </dd> </dl> -<a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a> -<h4>DocStyleChecker.__error</h4> -<b>__error</b>(<i>lineNumber, offset, code, *args</i>) -<p> - Private method to record an issue. -</p> - -<dl> - -<dt><i>lineNumber</i> (int)</dt> -<dd> -line number of the issue -</dd> -<dt><i>offset</i> (int)</dt> -<dd> -position within line of the issue -</dd> -<dt><i>code</i> (str)</dt> -<dd> -message code -</dd> -<dt><i>args</i> (list)</dt> -<dd> -arguments for the message -</dd> -</dl> <a NAME="DocStyleChecker.__getArgNames" ID="DocStyleChecker.__getArgNames"></a> <h4>DocStyleChecker.__getArgNames</h4> <b>__getArgNames</b>(<i>node</i>) @@ -970,32 +941,6 @@ int </dd> </dl> -<a NAME="DocStyleChecker.__ignoreCode" ID="DocStyleChecker.__ignoreCode"></a> -<h4>DocStyleChecker.__ignoreCode</h4> -<b>__ignoreCode</b>(<i>code</i>) -<p> - Private method to check if the error code should be ignored. -</p> - -<dl> - -<dt><i>code</i> (str)</dt> -<dd> -message code to check for -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -flag indicating to ignore the given code -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> <a NAME="DocStyleChecker.__parseClasses" ID="DocStyleChecker.__parseClasses"></a> <h4>DocStyleChecker.__parseClasses</h4> <b>__parseClasses</b>(<i></i>) @@ -1213,6 +1158,32 @@ tuple </dd> </dl> +<a NAME="DocStyleChecker.addError" ID="DocStyleChecker.addError"></a> +<h4>DocStyleChecker.addError</h4> +<b>addError</b>(<i>lineNumber, offset, msgCode, *args</i>) +<p> + Public method to record an issue. +</p> + +<dl> + +<dt><i>lineNumber</i> (int)</dt> +<dd> +line number of the issue (zero based) +</dd> +<dt><i>offset</i> (int)</dt> +<dd> +position within line of the issue +</dd> +<dt><i>msgCode</i> (str)</dt> +<dd> +message code +</dd> +<dt><i>args</i> (list)</dt> +<dd> +arguments for the message +</dd> +</dl> <a NAME="DocStyleChecker.run" ID="DocStyleChecker.run"></a> <h4>DocStyleChecker.run</h4> <b>run</b>(<i></i>)