src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.EricdocGenerator.html

branch
eric7
changeset 9503
ae9232bf4854
parent 9209
b99e7fd55fd3
child 10070
9f5758c0fec1
--- a/src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.EricdocGenerator.html	Wed Nov 09 15:17:05 2022 +0100
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.EricdocGenerator.html	Wed Nov 09 15:18:07 2022 +0100
@@ -26,22 +26,23 @@
 <table>
 
 <tr>
-<td><a href="#generateEricDoc">generateEricDoc</a></td>
+<td><a href="#generateDoc">generateDoc</a></td>
 <td>Function to generate the docstring line list iaw.</td>
 </tr>
 </table>
 <hr />
 <hr />
-<a NAME="generateEricDoc" ID="generateEricDoc"></a>
-<h2>generateEricDoc</h2>
-<b>generateEricDoc</b>(<i>functionInfo</i>)
+<a NAME="generateDoc" ID="generateDoc"></a>
+<h2>generateDoc</h2>
+<b>generateDoc</b>(<i>functionInfo, editor</i>)
 
 <p>
-    Function to generate the docstring line list iaw. eric documentation style.
+    Function to generate the docstring line list iaw. eric documentation
+    style.
 </p>
 <p>
-    Note: Partial English text is created with DESCRIPTION placeholders
-    for descriptions and TYPE placeholders for type information
+    Note: Text is created with DESCRIPTION placeholders for descriptions and
+    TYPE placeholders for type information
 </p>
 <dl>
 
@@ -50,6 +51,10 @@
 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>

eric ide

mercurial