Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.QScintilla.DocstringGenerator.PyDocstringGenerator.html
eric6/Documentation/Source/eric6.QScintilla.DocstringGenerator.PyDocstringGenerator.html
- changeset 8000
- 47b15df088e4
- parent 7998
- cd41c844862f
equal
deleted
inserted
replaced
| 7999:159689297bc0 | 8000:47b15df088e4 |
|---|---|
| 115 <tr> | 115 <tr> |
| 116 <td><a href="#PyDocstringGenerator.insertDocstring">insertDocstring</a></td> | 116 <td><a href="#PyDocstringGenerator.insertDocstring">insertDocstring</a></td> |
| 117 <td>Public method to insert a docstring for the function at the cursor position.</td> | 117 <td>Public method to insert a docstring for the function at the cursor position.</td> |
| 118 </tr> | 118 </tr> |
| 119 <tr> | 119 <tr> |
| 120 <td><a href="#PyDocstringGenerator.insertDocstringFromShortcut">insertDocstringFromShortcut</a></td> | |
| 121 <td>Public method to insert a docstring for the function at the cursor position initiated via a keyboard shortcut.</td> | |
| 122 </tr> | |
| 123 <tr> | |
| 120 <td><a href="#PyDocstringGenerator.isDocstringIntro">isDocstringIntro</a></td> | 124 <td><a href="#PyDocstringGenerator.isDocstringIntro">isDocstringIntro</a></td> |
| 121 <td>Public function to test, if the line up to the cursor position might be introducing a docstring.</td> | 125 <td>Public function to test, if the line up to the cursor position might be introducing a docstring.</td> |
| 122 </tr> | 126 </tr> |
| 123 <tr> | 127 <tr> |
| 124 <td><a href="#PyDocstringGenerator.isFunctionStart">isFunctionStart</a></td> | 128 <td><a href="#PyDocstringGenerator.isFunctionStart">isFunctionStart</a></td> |
| 401 </dd> | 405 </dd> |
| 402 <dt><i>fromStart</i> (bool)</dt> | 406 <dt><i>fromStart</i> (bool)</dt> |
| 403 <dd> | 407 <dd> |
| 404 flag indicating that the editor text cursor is placed | 408 flag indicating that the editor text cursor is placed |
| 405 on the line starting the function definition | 409 on the line starting the function definition |
| 410 </dd> | |
| 411 </dl> | |
| 412 <a NAME="PyDocstringGenerator.insertDocstringFromShortcut" ID="PyDocstringGenerator.insertDocstringFromShortcut"></a> | |
| 413 <h4>PyDocstringGenerator.insertDocstringFromShortcut</h4> | |
| 414 <b>insertDocstringFromShortcut</b>(<i>cursorPosition</i>) | |
| 415 | |
| 416 <p> | |
| 417 Public method to insert a docstring for the function at the cursor | |
| 418 position initiated via a keyboard shortcut. | |
| 419 </p> | |
| 420 <dl> | |
| 421 | |
| 422 <dt><i>cursorPosition</i> (tuple of (int, int))</dt> | |
| 423 <dd> | |
| 424 position of the cursor (line and index) | |
| 406 </dd> | 425 </dd> |
| 407 </dl> | 426 </dl> |
| 408 <a NAME="PyDocstringGenerator.isDocstringIntro" ID="PyDocstringGenerator.isDocstringIntro"></a> | 427 <a NAME="PyDocstringGenerator.isDocstringIntro" ID="PyDocstringGenerator.isDocstringIntro"></a> |
| 409 <h4>PyDocstringGenerator.isDocstringIntro</h4> | 428 <h4>PyDocstringGenerator.isDocstringIntro</h4> |
| 410 <b>isDocstringIntro</b>(<i>cursorPosition</i>) | 429 <b>isDocstringIntro</b>(<i>cursorPosition</i>) |
