Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.SphinxdocGenerator.html
src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.SphinxdocGenerator.html
- branch
- eric7
- changeset 10259
- b51dfacef37f
- parent 10070
- 9f5758c0fec1
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 10258:e7764f992a01 | 10259:b51dfacef37f |
|---|---|
| 25 | 25 |
| 26 <table> | 26 <table> |
| 27 | 27 |
| 28 <tr> | 28 <tr> |
| 29 <td><a href="#generateDoc">generateDoc</a></td> | 29 <td><a href="#generateDoc">generateDoc</a></td> |
| 30 <td></td> | 30 <td>Function to generate the docstring line list iaw.</td> |
| 31 </tr> | 31 </tr> |
| 32 </table> | 32 </table> |
| 33 <hr /> | 33 <hr /> |
| 34 <hr /> | 34 <hr /> |
| 35 <a NAME="generateDoc" ID="generateDoc"></a> | 35 <a NAME="generateDoc" ID="generateDoc"></a> |
| 36 <h2>generateDoc</h2> | 36 <h2>generateDoc</h2> |
| 37 <b>generateDoc</b>(<i>functionInfo, editor</i>) | 37 <b>generateDoc</b>(<i>functionInfo, editor</i>) |
| 38 | 38 |
| 39 <p> | |
| 40 Function to generate the docstring line list iaw. Sphinx documentation | |
| 41 style. | |
| 42 </p> | |
| 43 <p> | |
| 44 Note: Text is created with DESCRIPTION placeholders for descriptions and | |
| 45 TYPE placeholders for type information | |
| 46 </p> | |
| 47 <dl> | |
| 48 | |
| 49 <dt><i>functionInfo</i> (FunctionInfo)</dt> | |
| 50 <dd> | |
| 51 object containing the function information to base | |
| 52 the docstring on | |
| 53 </dd> | |
| 54 <dt><i>editor</i> (Editor)</dt> | |
| 55 <dd> | |
| 56 reference to the editor | |
| 57 </dd> | |
| 58 </dl> | |
| 59 <dl> | |
| 60 <dt>Return:</dt> | |
| 61 <dd> | |
| 62 list of docstring lines | |
| 63 </dd> | |
| 64 </dl> | |
| 65 <dl> | |
| 66 <dt>Return Type:</dt> | |
| 67 <dd> | |
| 68 str | |
| 69 </dd> | |
| 70 </dl> | |
| 39 <div align="right"><a href="#top">Up</a></div> | 71 <div align="right"><a href="#top">Up</a></div> |
| 40 <hr /> | 72 <hr /> |
| 41 </body></html> | 73 </body></html> |
