--- a/src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.BaseDocstringGenerator.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.BaseDocstringGenerator.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.QScintilla.DocstringGenerator.BaseDocstringGenerator</h1>
-
<p>
Module implementing a docstring generator base class.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#BaseDocstringGenerator">BaseDocstringGenerator</a></td>
<td>Class implementing a docstring generator base class.</td>
@@ -33,39 +31,37 @@
<td>Class implementing an object to store function information.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#getIndentStr">getIndentStr</a></td>
<td>Function to get the indentation of a text.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="BaseDocstringGenerator" ID="BaseDocstringGenerator"></a>
<h2>BaseDocstringGenerator</h2>
-
<p>
Class implementing a docstring generator base class.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#BaseDocstringGenerator.__init__">BaseDocstringGenerator</a></td>
<td>Constructor</td>
@@ -99,19 +95,20 @@
<td>Public method to test, if a text is the start of a function or method definition.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="BaseDocstringGenerator.__init__" ID="BaseDocstringGenerator.__init__"></a>
<h4>BaseDocstringGenerator (Constructor)</h4>
<b>BaseDocstringGenerator</b>(<i>editor</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -122,11 +119,11 @@
<a NAME="BaseDocstringGenerator._generateDocstringList" ID="BaseDocstringGenerator._generateDocstringList"></a>
<h4>BaseDocstringGenerator._generateDocstringList</h4>
<b>_generateDocstringList</b>(<i>functionInfo, docstringType</i>)
-
<p>
Protected method to generate type specific docstrings based on the
extracted function information.
</p>
+
<dl>
<dt><i>functionInfo</i> (FunctionInfo)</dt>
@@ -153,10 +150,10 @@
<a NAME="BaseDocstringGenerator.getDocstringType" ID="BaseDocstringGenerator.getDocstringType"></a>
<h4>BaseDocstringGenerator.getDocstringType</h4>
<b>getDocstringType</b>(<i></i>)
-
<p>
Public method to determine the docstring type to be generated.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -173,11 +170,11 @@
<a NAME="BaseDocstringGenerator.hasFunctionDefinition" ID="BaseDocstringGenerator.hasFunctionDefinition"></a>
<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>
@@ -200,11 +197,11 @@
<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>
@@ -220,11 +217,11 @@
<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>
@@ -235,11 +232,11 @@
<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>
@@ -262,11 +259,11 @@
<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>
@@ -292,7 +289,6 @@
<hr />
<a NAME="DocstringMenuForEnterOnly" ID="DocstringMenuForEnterOnly"></a>
<h2>DocstringMenuForEnterOnly</h2>
-
<p>
Class implementing a special menu reacting to the enter/return keys only.
</p>
@@ -300,22 +296,21 @@
If a keyboard input is not the "enter key", the menu is closed and the
input is inserted to the code editor.
</p>
+
<h3>Derived from</h3>
QMenu
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#DocstringMenuForEnterOnly.__init__">DocstringMenuForEnterOnly</a></td>
<td>Constructor</td>
@@ -325,19 +320,20 @@
<td>Protected method to handle key press events.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="DocstringMenuForEnterOnly.__init__" ID="DocstringMenuForEnterOnly.__init__"></a>
<h4>DocstringMenuForEnterOnly (Constructor)</h4>
<b>DocstringMenuForEnterOnly</b>(<i>editor</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -348,10 +344,10 @@
<a NAME="DocstringMenuForEnterOnly.keyPressEvent" ID="DocstringMenuForEnterOnly.keyPressEvent"></a>
<h4>DocstringMenuForEnterOnly.keyPressEvent</h4>
<b>keyPressEvent</b>(<i>evt</i>)
-
<p>
Protected method to handle key press events.
</p>
+
<dl>
<dt><i>evt</i> (QKeyEvent)</dt>
@@ -364,7 +360,6 @@
<hr />
<a NAME="FunctionInfo" ID="FunctionInfo"></a>
<h2>FunctionInfo</h2>
-
<p>
Class implementing an object to store function information.
</p>
@@ -372,22 +367,21 @@
Methods to extract the relevant information need to be implemented in
language specific subclasses.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#FunctionInfo.__init__">FunctionInfo</a></td>
<td>Constructor</td>
@@ -401,29 +395,30 @@
<td>Public method to parse the function definition text.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="FunctionInfo.__init__" ID="FunctionInfo.__init__"></a>
<h4>FunctionInfo (Constructor)</h4>
<b>FunctionInfo</b>(<i></i>)
-
<p>
Constructor
</p>
+
<a NAME="FunctionInfo.parseBody" ID="FunctionInfo.parseBody"></a>
<h4>FunctionInfo.parseBody</h4>
<b>parseBody</b>(<i>text</i>)
-
<p>
Public method to parse the function body text.
</p>
<p>
Note: This method should be overwritten in subclasses.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -434,13 +429,13 @@
<a NAME="FunctionInfo.parseDefinition" ID="FunctionInfo.parseDefinition"></a>
<h4>FunctionInfo.parseDefinition</h4>
<b>parseDefinition</b>(<i>text, quote, quoteReplace</i>)
-
<p>
Public method to parse the function definition text.
</p>
<p>
Note: This method should be overwritten in subclasses.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -462,10 +457,10 @@
<a NAME="getIndentStr" ID="getIndentStr"></a>
<h2>getIndentStr</h2>
<b>getIndentStr</b>(<i>text</i>)
-
<p>
Function to get the indentation of a text.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -487,4 +482,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
