Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.EricdocGenerator.html	Fri Oct 27 14:07:03 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.EricdocGenerator.html	Fri Oct 27 14:09:40 2023 +0200
@@ -27,7 +27,7 @@
 
 <tr>
 <td><a href="#generateDoc">generateDoc</a></td>
-<td></td>
+<td>Function to generate the docstring line list iaw.</td>
 </tr>
 </table>
 <hr />
@@ -36,6 +36,38 @@
 <h2>generateDoc</h2>
 <b>generateDoc</b>(<i>functionInfo, editor</i>)
 
+<p>
+    Function to generate the docstring line list iaw. eric documentation
+    style.
+</p>
+<p>
+    Note: Text is created with DESCRIPTION placeholders for descriptions and
+    TYPE placeholders for type information
+</p>
+<dl>
+
+<dt><i>functionInfo</i> (FunctionInfo)</dt>
+<dd>
+object containing the function information to base
+        the docstring on
+</dd>
+<dt><i>editor</i> (Editor)</dt>
+<dd>
+reference to the editor
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of docstring lines
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file