Mercurial Repositories > Rope Refactoring / file comparison
comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html
RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html
- changeset 232
- 65d7d745543d
- parent 217
- 874115c79ca7
- child 234
- a9d03af34d28
equal
deleted
inserted
replaced
| 231:6bc3382a7462 | 232:65d7d745543d |
|---|---|
| 76 <td>Private method to send some configuration data to the server.</td> | 76 <td>Private method to send some configuration data to the server.</td> |
| 77 </tr><tr> | 77 </tr><tr> |
| 78 <td><a href="#CodeAssistClient.__getDocumentation">__getDocumentation</a></td> | 78 <td><a href="#CodeAssistClient.__getDocumentation">__getDocumentation</a></td> |
| 79 <td>Private method to get some source code documentation.</td> | 79 <td>Private method to get some source code documentation.</td> |
| 80 </tr><tr> | 80 </tr><tr> |
| 81 <td><a href="#CodeAssistClient.__getObjectTypeAnName">__getObjectTypeAnName</a></td> | |
| 82 <td>Private method to determine an object type and name for the given location.</td> | |
| 83 </tr><tr> | |
| 81 <td><a href="#CodeAssistClient.__handleRopeError">__handleRopeError</a></td> | 84 <td><a href="#CodeAssistClient.__handleRopeError">__handleRopeError</a></td> |
| 82 <td>Private method to process a rope error.</td> | 85 <td>Private method to process a rope error.</td> |
| 83 </tr><tr> | 86 </tr><tr> |
| 84 <td><a href="#CodeAssistClient.__processDocumentation">__processDocumentation</a></td> | 87 <td><a href="#CodeAssistClient.__processDocumentation">__processDocumentation</a></td> |
| 85 <td>Private method to process the call-tips and documentation.</td> | 88 <td>Private method to process the call-tips and documentation.</td> |
| 176 </p><dl> | 179 </p><dl> |
| 177 <dt><i>params</i> (dict)</dt> | 180 <dt><i>params</i> (dict)</dt> |
| 178 <dd> | 181 <dd> |
| 179 dictionary containing the method parameters | 182 dictionary containing the method parameters |
| 180 </dd> | 183 </dd> |
| 184 </dl><a NAME="CodeAssistClient.__getObjectTypeAnName" ID="CodeAssistClient.__getObjectTypeAnName"></a> | |
| 185 <h4>CodeAssistClient.__getObjectTypeAnName</h4> | |
| 186 <b>__getObjectTypeAnName</b>(<i>project, sourceCode, offset, resource=None, maxfixes=1</i>) | |
| 187 <p> | |
| 188 Private method to determine an object type and name for the given | |
| 189 location. | |
| 190 </p><dl> | |
| 191 <dt><i>project</i> (rope.base.project.Project)</dt> | |
| 192 <dd> | |
| 193 reference to the rope project object | |
| 194 </dd><dt><i>sourceCode</i> (str)</dt> | |
| 195 <dd> | |
| 196 source code | |
| 197 </dd><dt><i>offset</i> (int)</dt> | |
| 198 <dd> | |
| 199 offset to base the calculation on | |
| 200 </dd><dt><i>resource</i> (rope.base.resources.Resource)</dt> | |
| 201 <dd> | |
| 202 reference to the rope resource object | |
| 203 </dd><dt><i>maxfixes</i> (int)</dt> | |
| 204 <dd> | |
| 205 number of fixes to be done | |
| 206 </dd> | |
| 181 </dl><a NAME="CodeAssistClient.__handleRopeError" ID="CodeAssistClient.__handleRopeError"></a> | 207 </dl><a NAME="CodeAssistClient.__handleRopeError" ID="CodeAssistClient.__handleRopeError"></a> |
| 182 <h4>CodeAssistClient.__handleRopeError</h4> | 208 <h4>CodeAssistClient.__handleRopeError</h4> |
| 183 <b>__handleRopeError</b>(<i>err</i>) | 209 <b>__handleRopeError</b>(<i>err</i>) |
| 184 <p> | 210 <p> |
| 185 Private method to process a rope error. | 211 Private method to process a rope error. |
| 198 <dd> | 224 <dd> |
| 199 dict | 225 dict |
| 200 </dd> | 226 </dd> |
| 201 </dl><a NAME="CodeAssistClient.__processDocumentation" ID="CodeAssistClient.__processDocumentation"></a> | 227 </dl><a NAME="CodeAssistClient.__processDocumentation" ID="CodeAssistClient.__processDocumentation"></a> |
| 202 <h4>CodeAssistClient.__processDocumentation</h4> | 228 <h4>CodeAssistClient.__processDocumentation</h4> |
| 203 <b>__processDocumentation</b>(<i>cts, documentation</i>) | 229 <b>__processDocumentation</b>(<i>cts, documentation, typeName</i>) |
| 204 <p> | 230 <p> |
| 205 Private method to process the call-tips and documentation. | 231 Private method to process the call-tips and documentation. |
| 206 </p><dl> | 232 </p><dl> |
| 207 <dt><i>cts</i> (str)</dt> | 233 <dt><i>cts</i> (str)</dt> |
| 208 <dd> | 234 <dd> |
| 209 call-tips | 235 call-tips |
| 210 </dd><dt><i>documentation</i> (str)</dt> | 236 </dd><dt><i>documentation</i> (str)</dt> |
| 211 <dd> | 237 <dd> |
| 212 extracted source code documentation | 238 extracted source code documentation |
| 239 </dd><dt><i>typeName</i> (tuple of (str, str))</dt> | |
| 240 <dd> | |
| 241 type and name of the object | |
| 213 </dd> | 242 </dd> |
| 214 </dl><dl> | 243 </dl><dl> |
| 215 <dt>Returns:</dt> | 244 <dt>Returns:</dt> |
| 216 <dd> | 245 <dd> |
| 217 dictionary containing document information | 246 dictionary containing document information |
