Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.EricdocGenerator.html
src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.EricdocGenerator.html
- branch
- eric7
- changeset 9503
- ae9232bf4854
- parent 9209
- b99e7fd55fd3
- child 10070
- 9f5758c0fec1
equal
deleted
inserted
replaced
| 9502:6091145e189e | 9503:ae9232bf4854 |
|---|---|
| 24 <h3>Functions</h3> | 24 <h3>Functions</h3> |
| 25 | 25 |
| 26 <table> | 26 <table> |
| 27 | 27 |
| 28 <tr> | 28 <tr> |
| 29 <td><a href="#generateEricDoc">generateEricDoc</a></td> | 29 <td><a href="#generateDoc">generateDoc</a></td> |
| 30 <td>Function to generate the docstring line list iaw.</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="generateEricDoc" ID="generateEricDoc"></a> | 35 <a NAME="generateDoc" ID="generateDoc"></a> |
| 36 <h2>generateEricDoc</h2> | 36 <h2>generateDoc</h2> |
| 37 <b>generateEricDoc</b>(<i>functionInfo</i>) | 37 <b>generateDoc</b>(<i>functionInfo, editor</i>) |
| 38 | 38 |
| 39 <p> | 39 <p> |
| 40 Function to generate the docstring line list iaw. eric documentation style. | 40 Function to generate the docstring line list iaw. eric documentation |
| 41 style. | |
| 41 </p> | 42 </p> |
| 42 <p> | 43 <p> |
| 43 Note: Partial English text is created with DESCRIPTION placeholders | 44 Note: Text is created with DESCRIPTION placeholders for descriptions and |
| 44 for descriptions and TYPE placeholders for type information | 45 TYPE placeholders for type information |
| 45 </p> | 46 </p> |
| 46 <dl> | 47 <dl> |
| 47 | 48 |
| 48 <dt><i>functionInfo</i> (FunctionInfo)</dt> | 49 <dt><i>functionInfo</i> (FunctionInfo)</dt> |
| 49 <dd> | 50 <dd> |
| 50 object containing the function information to base | 51 object containing the function information to base |
| 51 the docstring on | 52 the docstring on |
| 53 </dd> | |
| 54 <dt><i>editor</i> (Editor)</dt> | |
| 55 <dd> | |
| 56 reference to the editor | |
| 52 </dd> | 57 </dd> |
| 53 </dl> | 58 </dl> |
| 54 <dl> | 59 <dl> |
| 55 <dt>Return:</dt> | 60 <dt>Return:</dt> |
| 56 <dd> | 61 <dd> |
