--- a/src/eric7/Documentation/Source/eric7.JediInterface.JediServer.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.JediInterface.JediServer.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,51 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.JediInterface.JediServer</h1>
-
<p>
Module implementing the autocompletion interface to jedi.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#JediServer">JediServer</a></td>
<td>Class implementing the interface to the jedi library.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="JediServer" ID="JediServer"></a>
<h2>JediServer</h2>
-
<p>
Class implementing the interface to the jedi library.
</p>
+
<h3>Derived from</h3>
EricJsonServer
<h3>Class Attributes</h3>
+<table>
+<tr><td>IdProject</td></tr>
+<tr><td>PictureIDs</td></tr>
+</table>
-<table>
-<tr><td>IdProject</td></tr><tr><td>PictureIDs</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#JediServer.__init__">JediServer</a></td>
<td>Constructor</td>
@@ -195,19 +193,20 @@
<td>Public method to request a list of possible completions.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="JediServer.__init__" ID="JediServer.__init__"></a>
<h4>JediServer (Constructor)</h4>
<b>JediServer</b>(<i>viewManager, project, ui</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>viewManager</i> (ViewManager)</dt>
@@ -226,10 +225,10 @@
<a NAME="JediServer.__applyRefactoring" ID="JediServer.__applyRefactoring"></a>
<h4>JediServer.__applyRefactoring</h4>
<b>__applyRefactoring</b>(<i>uid</i>)
-
<p>
Private method to apply a given refactoring.
</p>
+
<dl>
<dt><i>uid</i> (str)</dt>
@@ -240,10 +239,10 @@
<a NAME="JediServer.__cancelRefactoring" ID="JediServer.__cancelRefactoring"></a>
<h4>JediServer.__cancelRefactoring</h4>
<b>__cancelRefactoring</b>(<i>uid</i>)
-
<p>
Private method to cancel a given refactoring.
</p>
+
<dl>
<dt><i>uid</i> (str)</dt>
@@ -254,10 +253,10 @@
<a NAME="JediServer.__checkRefactoringResult" ID="JediServer.__checkRefactoringResult"></a>
<h4>JediServer.__checkRefactoringResult</h4>
<b>__checkRefactoringResult</b>(<i>result</i>)
-
<p>
Private method to check the refactoring result for errors.
</p>
+
<dl>
<dt><i>result</i> (dict)</dt>
@@ -268,13 +267,13 @@
<a NAME="JediServer.__ensureActive" ID="JediServer.__ensureActive"></a>
<h4>JediServer.__ensureActive</h4>
<b>__ensureActive</b>(<i>idString</i>)
-
<p>
Private method to ensure, that the requested client is active.
</p>
<p>
A non-active client will be started.
</p>
+
<dl>
<dt><i>idString</i> (str)</dt>
@@ -297,10 +296,10 @@
<a NAME="JediServer.__idString" ID="JediServer.__idString"></a>
<h4>JediServer.__idString</h4>
<b>__idString</b>(<i>editor</i>)
-
<p>
Private method to determine the ID string for the back-end.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -323,11 +322,11 @@
<a NAME="JediServer.__interpreterForProject" ID="JediServer.__interpreterForProject"></a>
<h4>JediServer.__interpreterForProject</h4>
<b>__interpreterForProject</b>(<i></i>)
-
<p>
Private method to determine the interpreter for the current project and
the environment to run it.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -344,10 +343,10 @@
<a NAME="JediServer.__prepareData" ID="JediServer.__prepareData"></a>
<h4>JediServer.__prepareData</h4>
<b>__prepareData</b>(<i>editor</i>)
-
<p>
Private method to gather data about current cursor position.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -370,10 +369,10 @@
<a NAME="JediServer.__processCallTipsResult" ID="JediServer.__processCallTipsResult"></a>
<h4>JediServer.__processCallTipsResult</h4>
<b>__processCallTipsResult</b>(<i>result</i>)
-
<p>
Private method to process the calltips sent by the client.
</p>
+
<dl>
<dt><i>result</i> (dict)</dt>
@@ -384,10 +383,10 @@
<a NAME="JediServer.__processClientException" ID="JediServer.__processClientException"></a>
<h4>JediServer.__processClientException</h4>
<b>__processClientException</b>(<i>params</i>)
-
<p>
Private method to handle exceptions of the refactoring client.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -398,10 +397,10 @@
<a NAME="JediServer.__processCompletionsResult" ID="JediServer.__processCompletionsResult"></a>
<h4>JediServer.__processCompletionsResult</h4>
<b>__processCompletionsResult</b>(<i>result</i>)
-
<p>
Private method to process the completions sent by the client.
</p>
+
<dl>
<dt><i>result</i> (dict)</dt>
@@ -412,10 +411,10 @@
<a NAME="JediServer.__processDocumentationResult" ID="JediServer.__processDocumentationResult"></a>
<h4>JediServer.__processDocumentationResult</h4>
<b>__processDocumentationResult</b>(<i>result</i>)
-
<p>
Private method to process the documentation sent by the client.
</p>
+
<dl>
<dt><i>result</i> (dict with keys 'name', 'module', 'argspec', 'docstring')</dt>
@@ -426,10 +425,10 @@
<a NAME="JediServer.__processGotoDefinitionResult" ID="JediServer.__processGotoDefinitionResult"></a>
<h4>JediServer.__processGotoDefinitionResult</h4>
<b>__processGotoDefinitionResult</b>(<i>result</i>)
-
<p>
Private method callback for the goto definition result.
</p>
+
<dl>
<dt><i>result</i> (dict)</dt>
@@ -440,10 +439,10 @@
<a NAME="JediServer.__processGotoReferencesResult" ID="JediServer.__processGotoReferencesResult"></a>
<h4>JediServer.__processGotoReferencesResult</h4>
<b>__processGotoReferencesResult</b>(<i>result</i>)
-
<p>
Private method callback for the goto references result.
</p>
+
<dl>
<dt><i>result</i> (dict)</dt>
@@ -454,10 +453,10 @@
<a NAME="JediServer.__processHoverHelpResult" ID="JediServer.__processHoverHelpResult"></a>
<h4>JediServer.__processHoverHelpResult</h4>
<b>__processHoverHelpResult</b>(<i>result</i>)
-
<p>
Private method callback for the goto definition result.
</p>
+
<dl>
<dt><i>result</i> (dict)</dt>
@@ -468,24 +467,24 @@
<a NAME="JediServer.__projectClosed" ID="JediServer.__projectClosed"></a>
<h4>JediServer.__projectClosed</h4>
<b>__projectClosed</b>(<i></i>)
-
<p>
Private slot to handle the projectClosed signal.
</p>
+
<a NAME="JediServer.__projectOpened" ID="JediServer.__projectOpened"></a>
<h4>JediServer.__projectOpened</h4>
<b>__projectOpened</b>(<i></i>)
-
<p>
Private slot to handle the projectOpened signal.
</p>
+
<a NAME="JediServer.__showRefactoringDiff" ID="JediServer.__showRefactoringDiff"></a>
<h4>JediServer.__showRefactoringDiff</h4>
<b>__showRefactoringDiff</b>(<i>result</i>)
-
<p>
Private method to show the diff of a refactoring.
</p>
+
<dl>
<dt><i>result</i> (dict)</dt>
@@ -496,10 +495,10 @@
<a NAME="JediServer.__startJediClient" ID="JediServer.__startJediClient"></a>
<h4>JediServer.__startJediClient</h4>
<b>__startJediClient</b>(<i>interpreter, idString, clientEnv</i>)
-
<p>
Private method to start the Jedi client with the given interpreter.
</p>
+
<dl>
<dt><i>interpreter</i> (str)</dt>
@@ -531,31 +530,31 @@
<a NAME="JediServer.__updateEditorLanguageMapping" ID="JediServer.__updateEditorLanguageMapping"></a>
<h4>JediServer.__updateEditorLanguageMapping</h4>
<b>__updateEditorLanguageMapping</b>(<i></i>)
-
<p>
Private method to update the editor language to connection mapping.
</p>
+
<a NAME="JediServer.activate" ID="JediServer.activate"></a>
<h4>JediServer.activate</h4>
<b>activate</b>(<i></i>)
-
<p>
Public method to activate the Jedi server.
</p>
+
<a NAME="JediServer.deactivate" ID="JediServer.deactivate"></a>
<h4>JediServer.deactivate</h4>
<b>deactivate</b>(<i></i>)
-
<p>
Public method to deactivate the code assist server.
</p>
+
<a NAME="JediServer.forgetEditor" ID="JediServer.forgetEditor"></a>
<h4>JediServer.forgetEditor</h4>
<b>forgetEditor</b>(<i>editor</i>)
-
<p>
Public method to forget about the given editor.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -566,10 +565,10 @@
<a NAME="JediServer.getCallTips" ID="JediServer.getCallTips"></a>
<h4>JediServer.getCallTips</h4>
<b>getCallTips</b>(<i>editor, pos, commas</i>)
-
<p>
Public method to calculate calltips.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -600,7 +599,6 @@
<a NAME="JediServer.gotoDefinition" ID="JediServer.gotoDefinition"></a>
<h4>JediServer.gotoDefinition</h4>
<b>gotoDefinition</b>(<i>editor</i>)
-
<p>
Public slot to find the definition for the word at the cursor position
and go to it.
@@ -608,6 +606,7 @@
<p>
Note: This is executed upon a mouse click sequence.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -618,10 +617,10 @@
<a NAME="JediServer.handleCall" ID="JediServer.handleCall"></a>
<h4>JediServer.handleCall</h4>
<b>handleCall</b>(<i>method, params</i>)
-
<p>
Public method to handle a method call from the client.
</p>
+
<dl>
<dt><i>method</i> (str)</dt>
@@ -636,17 +635,17 @@
<a NAME="JediServer.handleNewConnection" ID="JediServer.handleNewConnection"></a>
<h4>JediServer.handleNewConnection</h4>
<b>handleNewConnection</b>(<i></i>)
-
<p>
Public slot for new incoming connections from a client.
</p>
+
<a NAME="JediServer.hoverHelp" ID="JediServer.hoverHelp"></a>
<h4>JediServer.hoverHelp</h4>
<b>hoverHelp</b>(<i>editor, line, index</i>)
-
<p>
Public method to initiate the display of mouse hover help.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -665,10 +664,10 @@
<a NAME="JediServer.isSupportedLanguage" ID="JediServer.isSupportedLanguage"></a>
<h4>JediServer.isSupportedLanguage</h4>
<b>isSupportedLanguage</b>(<i>language</i>)
-
<p>
Public method to check, if the given language is supported.
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -691,42 +690,42 @@
<a NAME="JediServer.refactoringExtractFunction" ID="JediServer.refactoringExtractFunction"></a>
<h4>JediServer.refactoringExtractFunction</h4>
<b>refactoringExtractFunction</b>(<i></i>)
-
<p>
Public slot to extract an expression to a function.
</p>
+
<a NAME="JediServer.refactoringExtractNewVariable" ID="JediServer.refactoringExtractNewVariable"></a>
<h4>JediServer.refactoringExtractNewVariable</h4>
<b>refactoringExtractNewVariable</b>(<i></i>)
-
<p>
Public slot to extract a statement to a new variable.
</p>
+
<a NAME="JediServer.refactoringInlineVariable" ID="JediServer.refactoringInlineVariable"></a>
<h4>JediServer.refactoringInlineVariable</h4>
<b>refactoringInlineVariable</b>(<i></i>)
-
<p>
Public slot to inline the selected variable.
</p>
<p>
Note: This is the opposite to Extract New Variable.
</p>
+
<a NAME="JediServer.refactoringRenameVariable" ID="JediServer.refactoringRenameVariable"></a>
<h4>JediServer.refactoringRenameVariable</h4>
<b>refactoringRenameVariable</b>(<i></i>)
-
<p>
Public slot to rename the selected variable.
</p>
+
<a NAME="JediServer.requestCodeDocumentation" ID="JediServer.requestCodeDocumentation"></a>
<h4>JediServer.requestCodeDocumentation</h4>
<b>requestCodeDocumentation</b>(<i>editor</i>)
-
<p>
Public method to request source code documentation for the given
editor.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -738,10 +737,10 @@
<a NAME="JediServer.requestCompletions" ID="JediServer.requestCompletions"></a>
<h4>JediServer.requestCompletions</h4>
<b>requestCompletions</b>(<i>editor, context, acText</i>)
-
<p>
Public method to request a list of possible completions.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -759,4 +758,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
