Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.BaseDocstringGenerator.html
src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.BaseDocstringGenerator.html
- branch
- eric7
- changeset 10259
- b51dfacef37f
- parent 10070
- 9f5758c0fec1
- child 10431
- 64157aeb0312
equal
deleted
inserted
replaced
| 10258:e7764f992a01 | 10259:b51dfacef37f |
|---|---|
| 78 <td><a href="#BaseDocstringGenerator.getDocstringType">getDocstringType</a></td> | 78 <td><a href="#BaseDocstringGenerator.getDocstringType">getDocstringType</a></td> |
| 79 <td>Public method to determine the docstring type to be generated.</td> | 79 <td>Public method to determine the docstring type to be generated.</td> |
| 80 </tr> | 80 </tr> |
| 81 <tr> | 81 <tr> |
| 82 <td><a href="#BaseDocstringGenerator.hasFunctionDefinition">hasFunctionDefinition</a></td> | 82 <td><a href="#BaseDocstringGenerator.hasFunctionDefinition">hasFunctionDefinition</a></td> |
| 83 <td></td> | 83 <td>Public method to test, if the cursor is right below a function definition.</td> |
| 84 </tr> | 84 </tr> |
| 85 <tr> | 85 <tr> |
| 86 <td><a href="#BaseDocstringGenerator.insertDocstring">insertDocstring</a></td> | 86 <td><a href="#BaseDocstringGenerator.insertDocstring">insertDocstring</a></td> |
| 87 <td></td> | 87 <td>Public method to insert a docstring for the function at the cursor position.</td> |
| 88 </tr> | 88 </tr> |
| 89 <tr> | 89 <tr> |
| 90 <td><a href="#BaseDocstringGenerator.insertDocstringFromShortcut">insertDocstringFromShortcut</a></td> | 90 <td><a href="#BaseDocstringGenerator.insertDocstringFromShortcut">insertDocstringFromShortcut</a></td> |
| 91 <td></td> | 91 <td>Public method to insert a docstring for the function at the cursor position initiated via a keyboard shortcut.</td> |
| 92 </tr> | 92 </tr> |
| 93 <tr> | 93 <tr> |
| 94 <td><a href="#BaseDocstringGenerator.isDocstringIntro">isDocstringIntro</a></td> | 94 <td><a href="#BaseDocstringGenerator.isDocstringIntro">isDocstringIntro</a></td> |
| 95 <td></td> | 95 <td>Public function to test, if the line up to the cursor position might be introducing a docstring.</td> |
| 96 </tr> | 96 </tr> |
| 97 <tr> | 97 <tr> |
| 98 <td><a href="#BaseDocstringGenerator.isFunctionStart">isFunctionStart</a></td> | 98 <td><a href="#BaseDocstringGenerator.isFunctionStart">isFunctionStart</a></td> |
| 99 <td></td> | 99 <td>Public method to test, if a text is the start of a function or method definition.</td> |
| 100 </tr> | 100 </tr> |
| 101 </table> | 101 </table> |
| 102 <h3>Static Methods</h3> | 102 <h3>Static Methods</h3> |
| 103 | 103 |
| 104 <table> | 104 <table> |
| 172 </dl> | 172 </dl> |
| 173 <a NAME="BaseDocstringGenerator.hasFunctionDefinition" ID="BaseDocstringGenerator.hasFunctionDefinition"></a> | 173 <a NAME="BaseDocstringGenerator.hasFunctionDefinition" ID="BaseDocstringGenerator.hasFunctionDefinition"></a> |
| 174 <h4>BaseDocstringGenerator.hasFunctionDefinition</h4> | 174 <h4>BaseDocstringGenerator.hasFunctionDefinition</h4> |
| 175 <b>hasFunctionDefinition</b>(<i>cursorPosition</i>) | 175 <b>hasFunctionDefinition</b>(<i>cursorPosition</i>) |
| 176 | 176 |
| 177 <p> | |
| 178 Public method to test, if the cursor is right below a function | |
| 179 definition. | |
| 180 </p> | |
| 181 <dl> | |
| 182 | |
| 183 <dt><i>cursorPosition</i> (tuple of (int, int))</dt> | |
| 184 <dd> | |
| 185 current cursor position (line and column) | |
| 186 </dd> | |
| 187 </dl> | |
| 188 <dl> | |
| 189 <dt>Return:</dt> | |
| 190 <dd> | |
| 191 flag indicating cursor is right below a function definition | |
| 192 </dd> | |
| 193 </dl> | |
| 194 <dl> | |
| 195 <dt>Return Type:</dt> | |
| 196 <dd> | |
| 197 bool | |
| 198 </dd> | |
| 199 </dl> | |
| 177 <a NAME="BaseDocstringGenerator.insertDocstring" ID="BaseDocstringGenerator.insertDocstring"></a> | 200 <a NAME="BaseDocstringGenerator.insertDocstring" ID="BaseDocstringGenerator.insertDocstring"></a> |
| 178 <h4>BaseDocstringGenerator.insertDocstring</h4> | 201 <h4>BaseDocstringGenerator.insertDocstring</h4> |
| 179 <b>insertDocstring</b>(<i>cursorPosition, fromStart=True</i>) | 202 <b>insertDocstring</b>(<i>cursorPosition, fromStart=True</i>) |
| 180 | 203 |
| 204 <p> | |
| 205 Public method to insert a docstring for the function at the cursor | |
| 206 position. | |
| 207 </p> | |
| 208 <dl> | |
| 209 | |
| 210 <dt><i>cursorPosition</i> (tuple of (int, int))</dt> | |
| 211 <dd> | |
| 212 position of the cursor (line and index) | |
| 213 </dd> | |
| 214 <dt><i>fromStart</i> (bool)</dt> | |
| 215 <dd> | |
| 216 flag indicating that the editor text cursor is placed | |
| 217 on the line starting the function definition | |
| 218 </dd> | |
| 219 </dl> | |
| 181 <a NAME="BaseDocstringGenerator.insertDocstringFromShortcut" ID="BaseDocstringGenerator.insertDocstringFromShortcut"></a> | 220 <a NAME="BaseDocstringGenerator.insertDocstringFromShortcut" ID="BaseDocstringGenerator.insertDocstringFromShortcut"></a> |
| 182 <h4>BaseDocstringGenerator.insertDocstringFromShortcut</h4> | 221 <h4>BaseDocstringGenerator.insertDocstringFromShortcut</h4> |
| 183 <b>insertDocstringFromShortcut</b>(<i>cursorPosition</i>) | 222 <b>insertDocstringFromShortcut</b>(<i>cursorPosition</i>) |
| 184 | 223 |
| 224 <p> | |
| 225 Public method to insert a docstring for the function at the cursor | |
| 226 position initiated via a keyboard shortcut. | |
| 227 </p> | |
| 228 <dl> | |
| 229 | |
| 230 <dt><i>cursorPosition</i> (tuple of (int, int))</dt> | |
| 231 <dd> | |
| 232 position of the cursor (line and index) | |
| 233 </dd> | |
| 234 </dl> | |
| 185 <a NAME="BaseDocstringGenerator.isDocstringIntro" ID="BaseDocstringGenerator.isDocstringIntro"></a> | 235 <a NAME="BaseDocstringGenerator.isDocstringIntro" ID="BaseDocstringGenerator.isDocstringIntro"></a> |
| 186 <h4>BaseDocstringGenerator.isDocstringIntro</h4> | 236 <h4>BaseDocstringGenerator.isDocstringIntro</h4> |
| 187 <b>isDocstringIntro</b>(<i>cursorPosition</i>) | 237 <b>isDocstringIntro</b>(<i>cursorPosition</i>) |
| 188 | 238 |
| 239 <p> | |
| 240 Public function to test, if the line up to the cursor position might be | |
| 241 introducing a docstring. | |
| 242 </p> | |
| 243 <dl> | |
| 244 | |
| 245 <dt><i>cursorPosition</i> (tuple of (int, int))</dt> | |
| 246 <dd> | |
| 247 current cursor position (line and column) | |
| 248 </dd> | |
| 249 </dl> | |
| 250 <dl> | |
| 251 <dt>Return:</dt> | |
| 252 <dd> | |
| 253 flag indicating a potential start of a docstring | |
| 254 </dd> | |
| 255 </dl> | |
| 256 <dl> | |
| 257 <dt>Return Type:</dt> | |
| 258 <dd> | |
| 259 bool | |
| 260 </dd> | |
| 261 </dl> | |
| 189 <a NAME="BaseDocstringGenerator.isFunctionStart" ID="BaseDocstringGenerator.isFunctionStart"></a> | 262 <a NAME="BaseDocstringGenerator.isFunctionStart" ID="BaseDocstringGenerator.isFunctionStart"></a> |
| 190 <h4>BaseDocstringGenerator.isFunctionStart</h4> | 263 <h4>BaseDocstringGenerator.isFunctionStart</h4> |
| 191 <b>isFunctionStart</b>(<i>text</i>) | 264 <b>isFunctionStart</b>(<i>text</i>) |
| 192 | 265 |
| 266 <p> | |
| 267 Public method to test, if a text is the start of a function or method | |
| 268 definition. | |
| 269 </p> | |
| 270 <dl> | |
| 271 | |
| 272 <dt><i>text</i> (str)</dt> | |
| 273 <dd> | |
| 274 line of text to be tested | |
| 275 </dd> | |
| 276 </dl> | |
| 277 <dl> | |
| 278 <dt>Return:</dt> | |
| 279 <dd> | |
| 280 flag indicating that the given text starts a function or | |
| 281 method definition (always False) | |
| 282 </dd> | |
| 283 </dl> | |
| 284 <dl> | |
| 285 <dt>Return Type:</dt> | |
| 286 <dd> | |
| 287 bool | |
| 288 </dd> | |
| 289 </dl> | |
| 193 <div align="right"><a href="#top">Up</a></div> | 290 <div align="right"><a href="#top">Up</a></div> |
| 194 <hr /> | 291 <hr /> |
| 195 <hr /> | 292 <hr /> |
| 196 <a NAME="DocstringMenuForEnterOnly" ID="DocstringMenuForEnterOnly"></a> | 293 <a NAME="DocstringMenuForEnterOnly" ID="DocstringMenuForEnterOnly"></a> |
| 197 <h2>DocstringMenuForEnterOnly</h2> | 294 <h2>DocstringMenuForEnterOnly</h2> |
