src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.BaseDocstringGenerator.html

branch
eric7
changeset 10684
58c7f23ae1cb
parent 10479
856476537696
equal deleted inserted replaced
10683:779cda568acb 10684:58c7f23ae1cb
177 177
178 <dl> 178 <dl>
179 179
180 <dt><i>cursorPosition</i> (tuple of (int, int))</dt> 180 <dt><i>cursorPosition</i> (tuple of (int, int))</dt>
181 <dd> 181 <dd>
182 current cursor position (line and column) 182 current cursor position (line and column) (unused)
183 </dd> 183 </dd>
184 </dl> 184 </dl>
185 <dl> 185 <dl>
186 <dt>Return:</dt> 186 <dt>Return:</dt>
187 <dd> 187 <dd>
204 204
205 <dl> 205 <dl>
206 206
207 <dt><i>cursorPosition</i> (tuple of (int, int))</dt> 207 <dt><i>cursorPosition</i> (tuple of (int, int))</dt>
208 <dd> 208 <dd>
209 position of the cursor (line and index) 209 position of the cursor (line and index) (unused)
210 </dd> 210 </dd>
211 <dt><i>fromStart</i> (bool)</dt> 211 <dt><i>fromStart</i> (bool)</dt>
212 <dd> 212 <dd>
213 flag indicating that the editor text cursor is placed 213 flag indicating that the editor text cursor is placed
214 on the line starting the function definition 214 on the line starting the function definition (unused)
215 </dd> 215 </dd>
216 </dl> 216 </dl>
217 <a NAME="BaseDocstringGenerator.insertDocstringFromShortcut" ID="BaseDocstringGenerator.insertDocstringFromShortcut"></a> 217 <a NAME="BaseDocstringGenerator.insertDocstringFromShortcut" ID="BaseDocstringGenerator.insertDocstringFromShortcut"></a>
218 <h4>BaseDocstringGenerator.insertDocstringFromShortcut</h4> 218 <h4>BaseDocstringGenerator.insertDocstringFromShortcut</h4>
219 <b>insertDocstringFromShortcut</b>(<i>cursorPosition</i>) 219 <b>insertDocstringFromShortcut</b>(<i>cursorPosition</i>)
224 224
225 <dl> 225 <dl>
226 226
227 <dt><i>cursorPosition</i> (tuple of (int, int))</dt> 227 <dt><i>cursorPosition</i> (tuple of (int, int))</dt>
228 <dd> 228 <dd>
229 position of the cursor (line and index) 229 position of the cursor (line and index) (unused)
230 </dd> 230 </dd>
231 </dl> 231 </dl>
232 <a NAME="BaseDocstringGenerator.isDocstringIntro" ID="BaseDocstringGenerator.isDocstringIntro"></a> 232 <a NAME="BaseDocstringGenerator.isDocstringIntro" ID="BaseDocstringGenerator.isDocstringIntro"></a>
233 <h4>BaseDocstringGenerator.isDocstringIntro</h4> 233 <h4>BaseDocstringGenerator.isDocstringIntro</h4>
234 <b>isDocstringIntro</b>(<i>cursorPosition</i>) 234 <b>isDocstringIntro</b>(<i>cursorPosition</i>)
239 239
240 <dl> 240 <dl>
241 241
242 <dt><i>cursorPosition</i> (tuple of (int, int))</dt> 242 <dt><i>cursorPosition</i> (tuple of (int, int))</dt>
243 <dd> 243 <dd>
244 current cursor position (line and column) 244 current cursor position (line and column) (unused)
245 </dd> 245 </dd>
246 </dl> 246 </dl>
247 <dl> 247 <dl>
248 <dt>Return:</dt> 248 <dt>Return:</dt>
249 <dd> 249 <dd>
266 266
267 <dl> 267 <dl>
268 268
269 <dt><i>text</i> (str)</dt> 269 <dt><i>text</i> (str)</dt>
270 <dd> 270 <dd>
271 line of text to be tested 271 line of text to be tested (unused)
272 </dd> 272 </dd>
273 </dl> 273 </dl>
274 <dl> 274 <dl>
275 <dt>Return:</dt> 275 <dt>Return:</dt>
276 <dd> 276 <dd>

eric ide

mercurial