diff -r c38750e1bafd -r b4bf79b956bc RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html Fri Sep 29 10:32:30 2017 +0200
@@ -0,0 +1,170 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient</title>
+<meta charset="UTF-8">
+<style>
+body {
+ background: #EDECE6;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+
+a { color: #BA6D36; }
+
+</style>
+</head>
+<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>None</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>
+JsonClient
+<h3>Class Attributes</h3>
+<table>
+<tr><td>PictureIDs</td></tr><tr><td>client</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>
+</tr><tr>
+<td><a href="#CodeAssistClient.__getCallTips">__getCallTips</a></td>
+<td>Private method to calculate possible calltips.</td>
+</tr><tr>
+<td><a href="#CodeAssistClient.__getCompletions">__getCompletions</a></td>
+<td>Private method to calculate possible completions.</td>
+</tr><tr>
+<td><a href="#CodeAssistClient.__handleRopeError">__handleRopeError</a></td>
+<td>Private method to process a rope error.</td>
+</tr><tr>
+<td><a href="#CodeAssistClient.__reportChanged">__reportChanged</a></td>
+<td>Private method to register some changed sources.</td>
+</tr><tr>
+<td><a href="#CodeAssistClient.handleCall">handleCall</a></td>
+<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>
+<dd>
+ip address the background service is listening
+</dd><dt><i>port</i> (int)</dt>
+<dd>
+port of the background service
+</dd><dt><i>idString</i> (str)</dt>
+<dd>
+assigned client id to be sent back to the server in
+ order to identify the connection
+</dd><dt><i>projectPath</i> (str)</dt>
+<dd>
+path to the project
+</dd>
+</dl><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>
+<dd>
+dictionary containing the method parameters
+</dd>
+</dl><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>
+<dd>
+dictionary containing the method parameters
+</dd>
+</dl><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>
+<dd>
+rope exception object
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+dictionary containing the error information
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl><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>
+<dd>
+dictionary containing the method parameters sent by
+ the server
+</dd>
+</dl><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>
+<dd>
+requested method name
+</dd><dt><i>params</i> (dict)</dt>
+<dd>
+dictionary with method specific parameters
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
