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 10479
- 856476537696
- parent 10259
- b51dfacef37f
- child 10684
- 58c7f23ae1cb
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.QScintilla.DocstringGenerator.SphinxdocGenerator</h1> | 9 <h1>eric7.QScintilla.DocstringGenerator.SphinxdocGenerator</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the docstring generator for the 'sphinxdoc' style. | 11 Module implementing the docstring generator for the 'sphinxdoc' style. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>None</td></tr> | 16 <tr><td>None</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | |
| 21 <table> | 20 <table> |
| 22 <tr><td>None</td></tr> | 21 <tr><td>None</td></tr> |
| 23 </table> | 22 </table> |
| 23 | |
| 24 <h3>Functions</h3> | 24 <h3>Functions</h3> |
| 25 | |
| 26 <table> | 25 <table> |
| 27 | |
| 28 <tr> | 26 <tr> |
| 29 <td><a href="#generateDoc">generateDoc</a></td> | 27 <td><a href="#generateDoc">generateDoc</a></td> |
| 30 <td>Function to generate the docstring line list iaw.</td> | 28 <td>Function to generate the docstring line list iaw.</td> |
| 31 </tr> | 29 </tr> |
| 32 </table> | 30 </table> |
| 31 | |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="generateDoc" ID="generateDoc"></a> | 34 <a NAME="generateDoc" ID="generateDoc"></a> |
| 36 <h2>generateDoc</h2> | 35 <h2>generateDoc</h2> |
| 37 <b>generateDoc</b>(<i>functionInfo, editor</i>) | 36 <b>generateDoc</b>(<i>functionInfo, editor</i>) |
| 38 | |
| 39 <p> | 37 <p> |
| 40 Function to generate the docstring line list iaw. Sphinx documentation | 38 Function to generate the docstring line list iaw. Sphinx documentation |
| 41 style. | 39 style. |
| 42 </p> | 40 </p> |
| 43 <p> | 41 <p> |
| 44 Note: Text is created with DESCRIPTION placeholders for descriptions and | 42 Note: Text is created with DESCRIPTION placeholders for descriptions and |
| 45 TYPE placeholders for type information | 43 TYPE placeholders for type information |
| 46 </p> | 44 </p> |
| 45 | |
| 47 <dl> | 46 <dl> |
| 48 | 47 |
| 49 <dt><i>functionInfo</i> (FunctionInfo)</dt> | 48 <dt><i>functionInfo</i> (FunctionInfo)</dt> |
| 50 <dd> | 49 <dd> |
| 51 object containing the function information to base | 50 object containing the function information to base |
