RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html

changeset 232
65d7d745543d
parent 217
874115c79ca7
child 234
a9d03af34d28
diff -r 6bc3382a7462 -r 65d7d745543d RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html
--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html	Sun Nov 05 15:47:47 2017 +0100
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html	Sun Nov 05 17:23:30 2017 +0100
@@ -78,6 +78,9 @@
 <td><a href="#CodeAssistClient.__getDocumentation">__getDocumentation</a></td>
 <td>Private method to get some source code documentation.</td>
 </tr><tr>
+<td><a href="#CodeAssistClient.__getObjectTypeAnName">__getObjectTypeAnName</a></td>
+<td>Private method to determine an object type and name for the given location.</td>
+</tr><tr>
 <td><a href="#CodeAssistClient.__handleRopeError">__handleRopeError</a></td>
 <td>Private method to process a rope error.</td>
 </tr><tr>
@@ -178,6 +181,29 @@
 <dd>
 dictionary containing the method parameters
 </dd>
+</dl><a NAME="CodeAssistClient.__getObjectTypeAnName" ID="CodeAssistClient.__getObjectTypeAnName"></a>
+<h4>CodeAssistClient.__getObjectTypeAnName</h4>
+<b>__getObjectTypeAnName</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>
+<dd>
+reference to the rope project object
+</dd><dt><i>sourceCode</i> (str)</dt>
+<dd>
+source code
+</dd><dt><i>offset</i> (int)</dt>
+<dd>
+offset to base the calculation on
+</dd><dt><i>resource</i> (rope.base.resources.Resource)</dt>
+<dd>
+reference to the rope resource object
+</dd><dt><i>maxfixes</i> (int)</dt>
+<dd>
+number of fixes to be done
+</dd>
 </dl><a NAME="CodeAssistClient.__handleRopeError" ID="CodeAssistClient.__handleRopeError"></a>
 <h4>CodeAssistClient.__handleRopeError</h4>
 <b>__handleRopeError</b>(<i>err</i>)
@@ -200,7 +226,7 @@
 </dd>
 </dl><a NAME="CodeAssistClient.__processDocumentation" ID="CodeAssistClient.__processDocumentation"></a>
 <h4>CodeAssistClient.__processDocumentation</h4>
-<b>__processDocumentation</b>(<i>cts, documentation</i>)
+<b>__processDocumentation</b>(<i>cts, documentation, typeName</i>)
 <p>
         Private method to process the call-tips and documentation.
 </p><dl>
@@ -210,6 +236,9 @@
 </dd><dt><i>documentation</i> (str)</dt>
 <dd>
 extracted source code documentation
+</dd><dt><i>typeName</i> (tuple of (str, str))</dt>
+<dd>
+type and name of the object
 </dd>
 </dl><dl>
 <dt>Returns:</dt>

eric ide

mercurial