diff -r 47fb0119f0be -r 874115c79ca7 RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer.html
--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer.html Sun Oct 08 19:11:45 2017 +0200
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer.html Sat Oct 14 19:31:11 2017 +0200
@@ -78,6 +78,9 @@
<td><a href="#CodeAssistServer.__processCompletionsResult">__processCompletionsResult</a></td>
<td>Private method to process the completions sent by the client.</td>
</tr><tr>
+<td><a href="#CodeAssistServer.__processDocumentationResult">__processDocumentationResult</a></td>
+<td>Private method to process the documentation sent by the client.</td>
+</tr><tr>
<td><a href="#CodeAssistServer.__ropeConfigFile">__ropeConfigFile</a></td>
<td>Private method to get the name of the rope configuration file.</td>
</tr><tr>
@@ -135,6 +138,9 @@
<td><a href="#CodeAssistServer.reportChanged">reportChanged</a></td>
<td>Public slot to report some changed sources.</td>
</tr><tr>
+<td><a href="#CodeAssistServer.requestCodeDocumentation">requestCodeDocumentation</a></td>
+<td>Public method to request source code documentation for the given editor.</td>
+</tr><tr>
<td><a href="#CodeAssistServer.requestCompletions">requestCompletions</a></td>
<td>Public method to request a list of possible completions.</td>
</tr>
@@ -174,6 +180,11 @@
</p><p>
A non-active client will be started.
</p><dl>
+<dt><i>idString</i> (str)</dt>
+<dd>
+id of the client to be checked
+</dd>
+</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating an active client
@@ -218,6 +229,16 @@
<dd>
dictionary containing the result sent by the client
</dd>
+</dl><a NAME="CodeAssistServer.__processDocumentationResult" ID="CodeAssistServer.__processDocumentationResult"></a>
+<h4>CodeAssistServer.__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)</dt>
+<dd>
+dictionary containing the result sent by the client
+</dd>
</dl><a NAME="CodeAssistServer.__ropeConfigFile" ID="CodeAssistServer.__ropeConfigFile"></a>
<h4>CodeAssistServer.__ropeConfigFile</h4>
<b>__ropeConfigFile</b>(<i>idString</i>)
@@ -244,7 +265,7 @@
<p>
Private method to set the auto-completion hook.
</p><dl>
-<dt><i>editor</i> (QScintilla.Editor)</dt>
+<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
<dd>
reference to the editor
</dd>
@@ -254,7 +275,7 @@
<p>
Private method to set the calltip hook.
</p><dl>
-<dt><i>editor</i> (QScintilla.Editor)</dt>
+<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
<dd>
reference to the editor
</dd>
@@ -298,7 +319,7 @@
<p>
Private method to unset the auto-completion hook.
</p><dl>
-<dt><i>editor</i> (QScintilla.Editor)</dt>
+<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
<dd>
reference to the editor
</dd>
@@ -308,7 +329,7 @@
<p>
Private method to unset the calltip hook.
</p><dl>
-<dt><i>editor</i> (QScintilla.Editor)</dt>
+<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
<dd>
reference to the editor
</dd>
@@ -322,16 +343,13 @@
<b>activate</b>(<i></i>)
<p>
Public method to activate the code assist server.
-</p><p>
- Note: This method provides for some growth potential.
- Currently it is empty.
</p><a NAME="CodeAssistServer.connectEditor" ID="CodeAssistServer.connectEditor"></a>
<h4>CodeAssistServer.connectEditor</h4>
<b>connectEditor</b>(<i>editor</i>)
<p>
Public method to connect an editor.
</p><dl>
-<dt><i>editor</i> (QScintilla.Editor)</dt>
+<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
<dd>
reference to the editor
</dd>
@@ -346,7 +364,7 @@
<p>
Public method to disconnect an editor.
</p><dl>
-<dt><i>editor</i> (QScintilla.Editor)</dt>
+<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
<dd>
reference to the editor
</dd>
@@ -366,7 +384,7 @@
<p>
Public method to calculate calltips.
</p><dl>
-<dt><i>editor</i> (QScintilla.Editor)</dt>
+<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
<dd>
reference to the editor object, that called this method
</dd><dt><i>pos</i> (int)</dt>
@@ -394,7 +412,7 @@
</p><p>
Note: This is the synchronous variant for eric6 before 17.11.
</p><dl>
-<dt><i>editor</i> (QScintilla.Editor)</dt>
+<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
<dd>
reference to the editor object, that called this method
</dd><dt><i>context</i> (bool)</dt>
@@ -462,6 +480,18 @@
<dd>
source code before the change
</dd>
+</dl><a NAME="CodeAssistServer.requestCodeDocumentation" ID="CodeAssistServer.requestCodeDocumentation"></a>
+<h4>CodeAssistServer.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> (QScintilla.Editor.Editor)</dt>
+<dd>
+reference to the editor to get source code documentation
+ for
+</dd>
</dl><a NAME="CodeAssistServer.requestCompletions" ID="CodeAssistServer.requestCompletions"></a>
<h4>CodeAssistServer.requestCompletions</h4>
<b>requestCompletions</b>(<i>editor, context, acText</i>)
@@ -471,7 +501,7 @@
Note: This is part of the asynchronous variant for eric6 17.11 and
later.
</p><dl>
-<dt><i>editor</i> (QScintilla.Editor)</dt>
+<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
<dd>
reference to the editor object, that called this method
</dd><dt><i>context</i> (bool)</dt>
