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 10684
- 58c7f23ae1cb
- parent 10479
- 856476537696
equal
deleted
inserted
replaced
| 10683:779cda568acb | 10684:58c7f23ae1cb |
|---|---|
| 31 | 31 |
| 32 <hr /> | 32 <hr /> |
| 33 <hr /> | 33 <hr /> |
| 34 <a NAME="generateDoc" ID="generateDoc"></a> | 34 <a NAME="generateDoc" ID="generateDoc"></a> |
| 35 <h2>generateDoc</h2> | 35 <h2>generateDoc</h2> |
| 36 <b>generateDoc</b>(<i>functionInfo, editor</i>) | 36 <b>generateDoc</b>(<i>functionInfo, _editor</i>) |
| 37 <p> | 37 <p> |
| 38 Function to generate the docstring line list iaw. Sphinx documentation | 38 Function to generate the docstring line list iaw. Sphinx documentation |
| 39 style. | 39 style. |
| 40 </p> | 40 </p> |
| 41 <p> | 41 <p> |
| 48 <dt><i>functionInfo</i> (FunctionInfo)</dt> | 48 <dt><i>functionInfo</i> (FunctionInfo)</dt> |
| 49 <dd> | 49 <dd> |
| 50 object containing the function information to base | 50 object containing the function information to base |
| 51 the docstring on | 51 the docstring on |
| 52 </dd> | 52 </dd> |
| 53 <dt><i>editor</i> (Editor)</dt> | 53 <dt><i>_editor</i> (Editor)</dt> |
| 54 <dd> | 54 <dd> |
| 55 reference to the editor | 55 reference to the editor (unused) |
| 56 </dd> | 56 </dd> |
| 57 </dl> | 57 </dl> |
| 58 <dl> | 58 <dl> |
| 59 <dt>Return:</dt> | 59 <dt>Return:</dt> |
| 60 <dd> | 60 <dd> |
