diff -r 78af27bb8201 -r 45159308166f RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html --- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html Wed Jan 03 16:44:06 2024 +0100 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html Sun Oct 13 15:49:43 2024 +0200 @@ -7,53 +7,53 @@ <body> <a NAME="top" ID="top"></a> <h1>Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient</h1> - <p> Module implementing the code assist client interface to rope. </p> + <h3>Global Attributes</h3> - <table> +<tr><td>QCoreApplication</td></tr> +<tr><td>app</td></tr> +<tr><td>client</td></tr> <tr><td>modulePath</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#CodeAssistClient">CodeAssistClient</a></td> <td>Class implementing the code assist client interface to rope.</td> </tr> </table> + <h3>Functions</h3> - <table> <tr><td>None</td></tr> </table> + <hr /> <hr /> <a NAME="CodeAssistClient" ID="CodeAssistClient"></a> <h2>CodeAssistClient</h2> - <p> Class implementing the code assist client interface to rope. </p> + <h3>Derived from</h3> EricJsonClient <h3>Class Attributes</h3> - <table> <tr><td>IdProject</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#CodeAssistClient.__init__">CodeAssistClient</a></td> <td>Constructor</td> @@ -111,19 +111,20 @@ <td>Public method to handle a method call from the server.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="CodeAssistClient.__init__" ID="CodeAssistClient.__init__"></a> <h4>CodeAssistClient (Constructor)</h4> <b>CodeAssistClient</b>(<i>host, port, idString, projectPath</i>) - <p> Constructor </p> + <dl> <dt><i>host</i> (str)</dt> @@ -147,10 +148,10 @@ <a NAME="CodeAssistClient.__closeProject" ID="CodeAssistClient.__closeProject"></a> <h4>CodeAssistClient.__closeProject</h4> <b>__closeProject</b>(<i>params</i>) - <p> Private slot to validate the project. </p> + <dl> <dt><i>params</i> (dict)</dt> @@ -162,10 +163,10 @@ <a NAME="CodeAssistClient.__configChanged" ID="CodeAssistClient.__configChanged"></a> <h4>CodeAssistClient.__configChanged</h4> <b>__configChanged</b>(<i>params</i>) - <p> Private method to handle a change of the configuration file. </p> + <dl> <dt><i>params</i> (dict)</dt> @@ -177,10 +178,10 @@ <a NAME="CodeAssistClient.__getCallTips" ID="CodeAssistClient.__getCallTips"></a> <h4>CodeAssistClient.__getCallTips</h4> <b>__getCallTips</b>(<i>params</i>) - <p> Private method to calculate possible calltips. </p> + <dl> <dt><i>params</i> (dict)</dt> @@ -191,10 +192,10 @@ <a NAME="CodeAssistClient.__getCompletions" ID="CodeAssistClient.__getCompletions"></a> <h4>CodeAssistClient.__getCompletions</h4> <b>__getCompletions</b>(<i>params</i>) - <p> Private method to calculate possible completions. </p> + <dl> <dt><i>params</i> (dict)</dt> @@ -205,10 +206,10 @@ <a NAME="CodeAssistClient.__getConfig" ID="CodeAssistClient.__getConfig"></a> <h4>CodeAssistClient.__getConfig</h4> <b>__getConfig</b>(<i>params</i>) - <p> Private method to send some configuration data to the server. </p> + <dl> <dt><i>params</i> (dict)</dt> @@ -220,10 +221,10 @@ <a NAME="CodeAssistClient.__getDocumentation" ID="CodeAssistClient.__getDocumentation"></a> <h4>CodeAssistClient.__getDocumentation</h4> <b>__getDocumentation</b>(<i>params</i>) - <p> Private method to get some source code documentation. </p> + <dl> <dt><i>params</i> (dict)</dt> @@ -234,11 +235,11 @@ <a NAME="CodeAssistClient.__getObjectTypeAndName" ID="CodeAssistClient.__getObjectTypeAndName"></a> <h4>CodeAssistClient.__getObjectTypeAndName</h4> <b>__getObjectTypeAndName</b>(<i>project, sourceCode, offset, resource=None, maxfixes=1</i>) - <p> Private method to determine an object type and name for the given location. </p> + <dl> <dt><i>project</i> (rope.base.project.Project)</dt> @@ -277,10 +278,10 @@ <a NAME="CodeAssistClient.__getReferences" ID="CodeAssistClient.__getReferences"></a> <h4>CodeAssistClient.__getReferences</h4> <b>__getReferences</b>(<i>params</i>) - <p> Private method to get the places a parameter is referenced. </p> + <dl> <dt><i>params</i> (dict)</dt> @@ -292,10 +293,10 @@ <a NAME="CodeAssistClient.__gotoDefinition" ID="CodeAssistClient.__gotoDefinition"></a> <h4>CodeAssistClient.__gotoDefinition</h4> <b>__gotoDefinition</b>(<i>params</i>) - <p> Private method to handle the Goto Definition action. </p> + <dl> <dt><i>params</i> (dict)</dt> @@ -307,10 +308,10 @@ <a NAME="CodeAssistClient.__handleRopeError" ID="CodeAssistClient.__handleRopeError"></a> <h4>CodeAssistClient.__handleRopeError</h4> <b>__handleRopeError</b>(<i>err</i>) - <p> Private method to process a rope error. </p> + <dl> <dt><i>err</i> (Exception)</dt> @@ -333,10 +334,10 @@ <a NAME="CodeAssistClient.__processDocumentation" ID="CodeAssistClient.__processDocumentation"></a> <h4>CodeAssistClient.__processDocumentation</h4> <b>__processDocumentation</b>(<i>cts, documentation, typeName</i>) - <p> Private method to process the call-tips and documentation. </p> + <dl> <dt><i>cts</i> (str)</dt> @@ -368,10 +369,10 @@ <a NAME="CodeAssistClient.__reportChanged" ID="CodeAssistClient.__reportChanged"></a> <h4>CodeAssistClient.__reportChanged</h4> <b>__reportChanged</b>(<i>params</i>) - <p> Private method to register some changed sources. </p> + <dl> <dt><i>params</i> (dict)</dt> @@ -383,10 +384,10 @@ <a NAME="CodeAssistClient.handleCall" ID="CodeAssistClient.handleCall"></a> <h4>CodeAssistClient.handleCall</h4> <b>handleCall</b>(<i>method, params</i>) - <p> Public method to handle a method call from the server. </p> + <dl> <dt><i>method</i> (str)</dt> @@ -400,4 +401,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>