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 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9503
- ae9232bf4854
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.QScintilla.DocstringGenerator.SphinxdocGenerator</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.QScintilla.DocstringGenerator.SphinxdocGenerator</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the docstring generator for the 'sphinxdoc' style. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 <tr><td>None</td></tr> | |
| 23 </table> | |
| 24 <h3>Functions</h3> | |
| 25 | |
| 26 <table> | |
| 27 | |
| 28 <tr> | |
| 29 <td><a href="#generateSphinxDoc">generateSphinxDoc</a></td> | |
| 30 <td>Function to generate the docstring line list iaw.</td> | |
| 31 </tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="generateSphinxDoc" ID="generateSphinxDoc"></a> | |
| 36 <h2>generateSphinxDoc</h2> | |
| 37 <b>generateSphinxDoc</b>(<i>functionInfo</i>) | |
| 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 </dl> | |
| 55 <dl> | |
| 56 <dt>Return:</dt> | |
| 57 <dd> | |
| 58 list of docstring lines | |
| 59 </dd> | |
| 60 </dl> | |
| 61 <dl> | |
| 62 <dt>Return Type:</dt> | |
| 63 <dd> | |
| 64 str | |
| 65 </dd> | |
| 66 </dl> | |
| 67 <div align="right"><a href="#top">Up</a></div> | |
| 68 <hr /> | |
| 69 </body></html> |
