Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.QScintilla.DocstringGenerator.BaseDocstringGenerator.html
eric6/Documentation/Source/eric6.QScintilla.DocstringGenerator.BaseDocstringGenerator.html
- changeset 8000
- 47b15df088e4
- parent 7998
- cd41c844862f
- child 8215
- fc5d68a6889e
equal
deleted
inserted
replaced
| 7999:159689297bc0 | 8000:47b15df088e4 |
|---|---|
| 99 <tr> | 99 <tr> |
| 100 <td><a href="#BaseDocstringGenerator.insertDocstring">insertDocstring</a></td> | 100 <td><a href="#BaseDocstringGenerator.insertDocstring">insertDocstring</a></td> |
| 101 <td>Public method to insert a docstring for the function at the cursor position.</td> | 101 <td>Public method to insert a docstring for the function at the cursor position.</td> |
| 102 </tr> | 102 </tr> |
| 103 <tr> | 103 <tr> |
| 104 <td><a href="#BaseDocstringGenerator.insertDocstringFromShortcut">insertDocstringFromShortcut</a></td> | |
| 105 <td>Public method to insert a docstring for the function at the cursor position initiated via a keyboard shortcut.</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 104 <td><a href="#BaseDocstringGenerator.isDocstringIntro">isDocstringIntro</a></td> | 108 <td><a href="#BaseDocstringGenerator.isDocstringIntro">isDocstringIntro</a></td> |
| 105 <td>Public function to test, if the line up to the cursor position might be introducing a docstring.</td> | 109 <td>Public function to test, if the line up to the cursor position might be introducing a docstring.</td> |
| 106 </tr> | 110 </tr> |
| 107 <tr> | 111 <tr> |
| 108 <td><a href="#BaseDocstringGenerator.isFunctionStart">isFunctionStart</a></td> | 112 <td><a href="#BaseDocstringGenerator.isFunctionStart">isFunctionStart</a></td> |
| 225 <dd> | 229 <dd> |
| 226 flag indicating that the editor text cursor is placed | 230 flag indicating that the editor text cursor is placed |
| 227 on the line starting the function definition | 231 on the line starting the function definition |
| 228 </dd> | 232 </dd> |
| 229 </dl> | 233 </dl> |
| 234 <a NAME="BaseDocstringGenerator.insertDocstringFromShortcut" ID="BaseDocstringGenerator.insertDocstringFromShortcut"></a> | |
| 235 <h4>BaseDocstringGenerator.insertDocstringFromShortcut</h4> | |
| 236 <b>insertDocstringFromShortcut</b>(<i>cursorPosition</i>) | |
| 237 | |
| 238 <p> | |
| 239 Public method to insert a docstring for the function at the cursor | |
| 240 position initiated via a keyboard shortcut. | |
| 241 </p> | |
| 242 <dl> | |
| 243 | |
| 244 <dt><i>cursorPosition</i> (tuple of (int, int))</dt> | |
| 245 <dd> | |
| 246 position of the cursor (line and index) | |
| 247 </dd> | |
| 248 </dl> | |
| 230 <a NAME="BaseDocstringGenerator.isDocstringIntro" ID="BaseDocstringGenerator.isDocstringIntro"></a> | 249 <a NAME="BaseDocstringGenerator.isDocstringIntro" ID="BaseDocstringGenerator.isDocstringIntro"></a> |
| 231 <h4>BaseDocstringGenerator.isDocstringIntro</h4> | 250 <h4>BaseDocstringGenerator.isDocstringIntro</h4> |
| 232 <b>isDocstringIntro</b>(<i>cursorPosition</i>) | 251 <b>isDocstringIntro</b>(<i>cursorPosition</i>) |
| 233 | 252 |
| 234 <p> | 253 <p> |
