Mercurial Repositories > eric / file diff

diff: eric6/Documentation/Source/eric6.Plugins.PluginSyntaxChecker.html

eric6/Documentation/Source/eric6.Plugins.PluginSyntaxChecker.html

changeset 7273
391d6b7b1eff
parent 7204
cbf6d88004ce
child 7989
a21d673a8f99
--- a/eric6/Documentation/Source/eric6.Plugins.PluginSyntaxChecker.html	Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.Plugins.PluginSyntaxChecker.html	Wed Sep 25 19:42:44 2019 +0200
@@ -18,232 +18,308 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
 <h1>eric6.Plugins.PluginSyntaxChecker</h1>
+
 <p>
 Module implementing the Syntax Checker plugin.
 </p>
 <h3>Global Attributes</h3>
+
 <table>
 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</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 />
+<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>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyntaxCheckerPlugin.__editorClosed">__editorClosed</a></td>
 <td>Private slot called, when an editor was closed.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyntaxCheckerPlugin.__editorOpened">__editorOpened</a></td>
 <td>Private slot called, when a new editor was opened.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyntaxCheckerPlugin.__editorShowMenu">__editorShowMenu</a></td>
 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyntaxCheckerPlugin.__editorSyntaxCheck">__editorSyntaxCheck</a></td>
 <td>Private slot to handle the syntax check context menu action of the editors.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyntaxCheckerPlugin.__getPythonOptions">__getPythonOptions</a></td>
 <td>Private methode to determine the syntax check options.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyntaxCheckerPlugin.__initialize">__initialize</a></td>
 <td>Private slot to (re)initialize the plugin.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyntaxCheckerPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td>
 <td>Private slot called, when the the project browser menu or a submenu is about to be shown.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyntaxCheckerPlugin.__projectBrowserSyntaxCheck">__projectBrowserSyntaxCheck</a></td>
 <td>Private method to handle the syntax check context menu action of the project sources browser.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyntaxCheckerPlugin.__projectShowMenu">__projectShowMenu</a></td>
 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyntaxCheckerPlugin.__projectSyntaxCheck">__projectSyntaxCheck</a></td>
 <td>Private slot used to check the project files for syntax errors.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyntaxCheckerPlugin.__translateSyntaxCheck">__translateSyntaxCheck</a></td>
 <td>Private slot to translate the resulting messages.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyntaxCheckerPlugin.activate">activate</a></td>
 <td>Public method to activate this plugin.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#SyntaxCheckerPlugin.deactivate">deactivate</a></td>
 <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>
+</p>
+<dl>
+
 <dt><i>ui</i></dt>
 <dd>
 reference to the user interface object (UI.UserInterface)
 </dd>
-</dl><a NAME="SyntaxCheckerPlugin.__editorClosed" ID="SyntaxCheckerPlugin.__editorClosed"></a>
+</dl>
+<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>
+</p>
+<dl>
+
 <dt><i>editor</i></dt>
 <dd>
 reference to the editor (QScintilla.Editor)
 </dd>
-</dl><a NAME="SyntaxCheckerPlugin.__editorOpened" ID="SyntaxCheckerPlugin.__editorOpened"></a>
+</dl>
+<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>
+</p>
+<dl>
+
 <dt><i>editor</i></dt>
 <dd>
 reference to the new editor (QScintilla.Editor)
 </dd>
-</dl><a NAME="SyntaxCheckerPlugin.__editorShowMenu" ID="SyntaxCheckerPlugin.__editorShowMenu"></a>
+</dl>
+<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>
+</p>
+<dl>
+
 <dt><i>menuName</i></dt>
 <dd>
 name of the menu to be shown (string)
-</dd><dt><i>menu</i></dt>
+</dd>
+<dt><i>menu</i></dt>
 <dd>
 reference to the menu (QMenu)
-</dd><dt><i>editor</i></dt>
+</dd>
+<dt><i>editor</i></dt>
 <dd>
 reference to the editor
 </dd>
-</dl><a NAME="SyntaxCheckerPlugin.__editorSyntaxCheck" ID="SyntaxCheckerPlugin.__editorSyntaxCheck"></a>
+</dl>
+<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>
+</p>
+<a NAME="SyntaxCheckerPlugin.__getPythonOptions" ID="SyntaxCheckerPlugin.__getPythonOptions"></a>
 <h4>SyntaxCheckerPlugin.__getPythonOptions</h4>
 <b>__getPythonOptions</b>(<i></i>)
+
 <p>
         Private methode to determine the syntax check options.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 state of checkFlakes and ignoreStarImportWarnings (bool, bool)
 </dd>
-</dl><a NAME="SyntaxCheckerPlugin.__initialize" ID="SyntaxCheckerPlugin.__initialize"></a>
+</dl>
+<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>
+</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>
+</p>
+<dl>
+
 <dt><i>menuName</i></dt>
 <dd>
 name of the menu to be shown (string)
-</dd><dt><i>menu</i></dt>
+</dd>
+<dt><i>menu</i></dt>
 <dd>
 reference to the menu (QMenu)
 </dd>
-</dl><a NAME="SyntaxCheckerPlugin.__projectBrowserSyntaxCheck" ID="SyntaxCheckerPlugin.__projectBrowserSyntaxCheck"></a>
+</dl>
+<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>
+</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>
+</p>
+<dl>
+
 <dt><i>menuName</i></dt>
 <dd>
 name of the menu to be shown (string)
-</dd><dt><i>menu</i></dt>
+</dd>
+<dt><i>menu</i></dt>
 <dd>
 reference to the menu (QMenu)
 </dd>
-</dl><a NAME="SyntaxCheckerPlugin.__projectSyntaxCheck" ID="SyntaxCheckerPlugin.__projectSyntaxCheck"></a>
+</dl>
+<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>
+</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><p>
+</p>
+<p>
         If checkFlakes is True, warnings contains a list of strings containing
         the warnings (marker, file name, line number, message)
         The values are only valid, if nok is False.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>fn</i></dt>
 <dd>
 filename of the checked file (str)
-</dd><dt><i>problems</i></dt>
+</dd>
+<dt><i>problems</i></dt>
 <dd>
 dictionary with the keys 'error' and 'warnings' which
             hold a list containing details about the error/ warnings
             (file name, line number, column, codestring (only at syntax
             errors), the message, a list with arguments for the message)
 </dd>
-</dl><a NAME="SyntaxCheckerPlugin.activate" ID="SyntaxCheckerPlugin.activate"></a>
+</dl>
+<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>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 tuple of None and activation status (boolean)
 </dd>
-</dl><a NAME="SyntaxCheckerPlugin.deactivate" ID="SyntaxCheckerPlugin.deactivate"></a>
+</dl>
+<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>

Mercurial Repository: eric

eric ide

mercurial