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

branch
eric7
changeset 9503
ae9232bf4854
parent 9209
b99e7fd55fd3
child 10070
9f5758c0fec1
equal deleted inserted replaced
9502:6091145e189e 9503:ae9232bf4854
390 390
391 <tr> 391 <tr>
392 <td><a href="#FunctionInfo.__init__">FunctionInfo</a></td> 392 <td><a href="#FunctionInfo.__init__">FunctionInfo</a></td>
393 <td>Constructor</td> 393 <td>Constructor</td>
394 </tr> 394 </tr>
395 <tr>
396 <td><a href="#FunctionInfo.parseBody">parseBody</a></td>
397 <td>Public method to parse the function body text.</td>
398 </tr>
399 <tr>
400 <td><a href="#FunctionInfo.parseDefinition">parseDefinition</a></td>
401 <td>Public method to parse the function definition text.</td>
402 </tr>
395 </table> 403 </table>
396 <h3>Static Methods</h3> 404 <h3>Static Methods</h3>
397 405
398 <table> 406 <table>
399 <tr><td>None</td></tr> 407 <tr><td>None</td></tr>
404 <b>FunctionInfo</b>(<i></i>) 412 <b>FunctionInfo</b>(<i></i>)
405 413
406 <p> 414 <p>
407 Constructor 415 Constructor
408 </p> 416 </p>
417 <a NAME="FunctionInfo.parseBody" ID="FunctionInfo.parseBody"></a>
418 <h4>FunctionInfo.parseBody</h4>
419 <b>parseBody</b>(<i>text</i>)
420
421 <p>
422 Public method to parse the function body text.
423 </p>
424 <p>
425 Note: This method should be overwritten in subclasses.
426 </p>
427 <dl>
428
429 <dt><i>text</i> (str)</dt>
430 <dd>
431 function body text
432 </dd>
433 </dl>
434 <a NAME="FunctionInfo.parseDefinition" ID="FunctionInfo.parseDefinition"></a>
435 <h4>FunctionInfo.parseDefinition</h4>
436 <b>parseDefinition</b>(<i>text, quote, quoteReplace</i>)
437
438 <p>
439 Public method to parse the function definition text.
440 </p>
441 <p>
442 Note: This method should be overwritten in subclasses.
443 </p>
444 <dl>
445
446 <dt><i>text</i> (str)</dt>
447 <dd>
448 text containing the function definition
449 </dd>
450 <dt><i>quote</i> (str)</dt>
451 <dd>
452 quote string to be replaced
453 </dd>
454 <dt><i>quoteReplace</i> (str)</dt>
455 <dd>
456 quote string to replace the original
457 </dd>
458 </dl>
409 <div align="right"><a href="#top">Up</a></div> 459 <div align="right"><a href="#top">Up</a></div>
410 <hr /> 460 <hr />
411 <hr /> 461 <hr />
412 <a NAME="getIndentStr" ID="getIndentStr"></a> 462 <a NAME="getIndentStr" ID="getIndentStr"></a>
413 <h2>getIndentStr</h2> 463 <h2>getIndentStr</h2>

eric ide

mercurial