Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.BaseDocstringGenerator.html	Fri Oct 27 14:07:03 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.BaseDocstringGenerator.html	Fri Oct 27 14:09:40 2023 +0200
@@ -80,23 +80,23 @@
 </tr>
 <tr>
 <td><a href="#BaseDocstringGenerator.hasFunctionDefinition">hasFunctionDefinition</a></td>
-<td></td>
+<td>Public method to test, if the cursor is right below a function definition.</td>
 </tr>
 <tr>
 <td><a href="#BaseDocstringGenerator.insertDocstring">insertDocstring</a></td>
-<td></td>
+<td>Public method to insert a docstring for the function at the cursor position.</td>
 </tr>
 <tr>
 <td><a href="#BaseDocstringGenerator.insertDocstringFromShortcut">insertDocstringFromShortcut</a></td>
-<td></td>
+<td>Public method to insert a docstring for the function at the cursor position initiated via a keyboard shortcut.</td>
 </tr>
 <tr>
 <td><a href="#BaseDocstringGenerator.isDocstringIntro">isDocstringIntro</a></td>
-<td></td>
+<td>Public function to test, if the line up to the cursor position might be introducing a docstring.</td>
 </tr>
 <tr>
 <td><a href="#BaseDocstringGenerator.isFunctionStart">isFunctionStart</a></td>
-<td></td>
+<td>Public method to test, if a text is the start of a function or method definition.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
@@ -174,22 +174,119 @@
 <h4>BaseDocstringGenerator.hasFunctionDefinition</h4>
 <b>hasFunctionDefinition</b>(<i>cursorPosition</i>)
 
+<p>
+        Public method to test, if the cursor is right below a function
+        definition.
+</p>
+<dl>
+
+<dt><i>cursorPosition</i> (tuple of (int, int))</dt>
+<dd>
+current cursor position (line and column)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating cursor is right below a function definition
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <a NAME="BaseDocstringGenerator.insertDocstring" ID="BaseDocstringGenerator.insertDocstring"></a>
 <h4>BaseDocstringGenerator.insertDocstring</h4>
 <b>insertDocstring</b>(<i>cursorPosition, fromStart=True</i>)
 
+<p>
+        Public method to insert a docstring for the function at the cursor
+        position.
+</p>
+<dl>
+
+<dt><i>cursorPosition</i> (tuple of (int, int))</dt>
+<dd>
+position of the cursor (line and index)
+</dd>
+<dt><i>fromStart</i> (bool)</dt>
+<dd>
+flag indicating that the editor text cursor is placed
+            on the line starting the function definition
+</dd>
+</dl>
 <a NAME="BaseDocstringGenerator.insertDocstringFromShortcut" ID="BaseDocstringGenerator.insertDocstringFromShortcut"></a>
 <h4>BaseDocstringGenerator.insertDocstringFromShortcut</h4>
 <b>insertDocstringFromShortcut</b>(<i>cursorPosition</i>)
 
+<p>
+        Public method to insert a docstring for the function at the cursor
+        position initiated via a keyboard shortcut.
+</p>
+<dl>
+
+<dt><i>cursorPosition</i> (tuple of (int, int))</dt>
+<dd>
+position of the cursor (line and index)
+</dd>
+</dl>
 <a NAME="BaseDocstringGenerator.isDocstringIntro" ID="BaseDocstringGenerator.isDocstringIntro"></a>
 <h4>BaseDocstringGenerator.isDocstringIntro</h4>
 <b>isDocstringIntro</b>(<i>cursorPosition</i>)
 
+<p>
+        Public function to test, if the line up to the cursor position might be
+        introducing a docstring.
+</p>
+<dl>
+
+<dt><i>cursorPosition</i> (tuple of (int, int))</dt>
+<dd>
+current cursor position (line and column)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a potential start of a docstring
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <a NAME="BaseDocstringGenerator.isFunctionStart" ID="BaseDocstringGenerator.isFunctionStart"></a>
 <h4>BaseDocstringGenerator.isFunctionStart</h4>
 <b>isFunctionStart</b>(<i>text</i>)
 
+<p>
+        Public method to test, if a text is the start of a function or method
+        definition.
+</p>
+<dl>
+
+<dt><i>text</i> (str)</dt>
+<dd>
+line of text to be tested
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating that the given text starts a function or
+            method definition (always False)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />