--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginSyntaxChecker.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginSyntaxChecker.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,53 +7,51 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.Plugins.PluginSyntaxChecker</h1> - <p> Module implementing the Syntax Checker plugin. </p> + <h3>Global Attributes</h3> - <table> -<tr><td>__header__</td></tr><tr><td>error</td></tr> +<tr><td>__header__</td></tr> +<tr><td>error</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#SyntaxCheckerPlugin">SyntaxCheckerPlugin</a></td> <td>Class implementing the Syntax Checker plugin.</td> </tr> </table> + <h3>Functions</h3> - <table> <tr><td>None</td></tr> </table> + <hr /> <hr /> <a NAME="SyntaxCheckerPlugin" ID="SyntaxCheckerPlugin"></a> <h2>SyntaxCheckerPlugin</h2> - <p> Class implementing the Syntax Checker plugin. </p> + <h3>Derived from</h3> QObject <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="#SyntaxCheckerPlugin.__init__">SyntaxCheckerPlugin</a></td> <td>Constructor</td> @@ -111,19 +109,20 @@ <td>Public method to deactivate this plugin.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="SyntaxCheckerPlugin.__init__" ID="SyntaxCheckerPlugin.__init__"></a> <h4>SyntaxCheckerPlugin (Constructor)</h4> <b>SyntaxCheckerPlugin</b>(<i>ui</i>) - <p> Constructor </p> + <dl> <dt><i>ui</i> (UI.UserInterface)</dt> @@ -134,10 +133,10 @@ <a NAME="SyntaxCheckerPlugin.__editorClosed" ID="SyntaxCheckerPlugin.__editorClosed"></a> <h4>SyntaxCheckerPlugin.__editorClosed</h4> <b>__editorClosed</b>(<i>editor</i>) - <p> Private slot called, when an editor was closed. </p> + <dl> <dt><i>editor</i> (QScintilla.Editor)</dt> @@ -148,10 +147,10 @@ <a NAME="SyntaxCheckerPlugin.__editorOpened" ID="SyntaxCheckerPlugin.__editorOpened"></a> <h4>SyntaxCheckerPlugin.__editorOpened</h4> <b>__editorOpened</b>(<i>editor</i>) - <p> Private slot called, when a new editor was opened. </p> + <dl> <dt><i>editor</i> (QScintilla.Editor)</dt> @@ -162,11 +161,11 @@ <a NAME="SyntaxCheckerPlugin.__editorShowMenu" ID="SyntaxCheckerPlugin.__editorShowMenu"></a> <h4>SyntaxCheckerPlugin.__editorShowMenu</h4> <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) - <p> Private slot called, when the the editor context menu or a submenu is about to be shown. </p> + <dl> <dt><i>menuName</i> (str)</dt> @@ -185,18 +184,18 @@ <a NAME="SyntaxCheckerPlugin.__editorSyntaxCheck" ID="SyntaxCheckerPlugin.__editorSyntaxCheck"></a> <h4>SyntaxCheckerPlugin.__editorSyntaxCheck</h4> <b>__editorSyntaxCheck</b>(<i></i>) - <p> Private slot to handle the syntax check context menu action of the editors. </p> + <a NAME="SyntaxCheckerPlugin.__getPythonOptions" ID="SyntaxCheckerPlugin.__getPythonOptions"></a> <h4>SyntaxCheckerPlugin.__getPythonOptions</h4> <b>__getPythonOptions</b>(<i></i>) - <p> Private method to determine the syntax check options. </p> + <dl> <dt>Return:</dt> <dd> @@ -213,18 +212,18 @@ <a NAME="SyntaxCheckerPlugin.__initialize" ID="SyntaxCheckerPlugin.__initialize"></a> <h4>SyntaxCheckerPlugin.__initialize</h4> <b>__initialize</b>(<i></i>) - <p> Private slot to (re)initialize the plugin. </p> + <a NAME="SyntaxCheckerPlugin.__projectBrowserShowMenu" ID="SyntaxCheckerPlugin.__projectBrowserShowMenu"></a> <h4>SyntaxCheckerPlugin.__projectBrowserShowMenu</h4> <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>) - <p> Private slot called, when the the project browser menu or a submenu is about to be shown. </p> + <dl> <dt><i>menuName</i> (str)</dt> @@ -239,19 +238,19 @@ <a NAME="SyntaxCheckerPlugin.__projectBrowserSyntaxCheck" ID="SyntaxCheckerPlugin.__projectBrowserSyntaxCheck"></a> <h4>SyntaxCheckerPlugin.__projectBrowserSyntaxCheck</h4> <b>__projectBrowserSyntaxCheck</b>(<i></i>) - <p> Private method to handle the syntax check context menu action of the project sources browser. </p> + <a NAME="SyntaxCheckerPlugin.__projectShowMenu" ID="SyntaxCheckerPlugin.__projectShowMenu"></a> <h4>SyntaxCheckerPlugin.__projectShowMenu</h4> <b>__projectShowMenu</b>(<i>menuName, menu</i>) - <p> Private slot called, when the the project menu or a submenu is about to be shown. </p> + <dl> <dt><i>menuName</i> (str)</dt> @@ -266,14 +265,13 @@ <a NAME="SyntaxCheckerPlugin.__projectSyntaxCheck" ID="SyntaxCheckerPlugin.__projectSyntaxCheck"></a> <h4>SyntaxCheckerPlugin.__projectSyntaxCheck</h4> <b>__projectSyntaxCheck</b>(<i></i>) - <p> Private slot used to check the project files for syntax errors. </p> + <a NAME="SyntaxCheckerPlugin.__translateSyntaxCheck" ID="SyntaxCheckerPlugin.__translateSyntaxCheck"></a> <h4>SyntaxCheckerPlugin.__translateSyntaxCheck</h4> <b>__translateSyntaxCheck</b>(<i>fn, problems</i>) - <p> Private slot to translate the resulting messages. </p> @@ -282,6 +280,7 @@ the warnings (marker, file name, line number, message) The values are only valid, if nok is False. </p> + <dl> <dt><i>fn</i> (str)</dt> @@ -301,10 +300,10 @@ <a NAME="SyntaxCheckerPlugin.activate" ID="SyntaxCheckerPlugin.activate"></a> <h4>SyntaxCheckerPlugin.activate</h4> <b>activate</b>(<i></i>) - <p> Public method to activate this plugin. </p> + <dl> <dt>Return:</dt> <dd> @@ -320,10 +319,10 @@ <a NAME="SyntaxCheckerPlugin.deactivate" ID="SyntaxCheckerPlugin.deactivate"></a> <h4>SyntaxCheckerPlugin.deactivate</h4> <b>deactivate</b>(<i></i>) - <p> Public method to deactivate this plugin. </p> + <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>