diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.PyDocstringGenerator.html
--- a/src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.PyDocstringGenerator.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.PyDocstringGenerator.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.QScintilla.DocstringGenerator.PyDocstringGenerator</h1>
-
<p>
Module implementing a docstring generator for Python.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#PyDocstringGenerator">PyDocstringGenerator</a></td>
<td>Class implementing a docstring generator for Python.</td>
@@ -29,35 +27,34 @@
<td>Class implementing an object to extract and store function information.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="PyDocstringGenerator" ID="PyDocstringGenerator"></a>
<h2>PyDocstringGenerator</h2>
-
<p>
Class implementing a docstring generator for Python.
</p>
+
<h3>Derived from</h3>
BaseDocstringGenerator
<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="#PyDocstringGenerator.__init__">PyDocstringGenerator</a></td>
<td>Constructor</td>
@@ -115,19 +112,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="PyDocstringGenerator.__init__" ID="PyDocstringGenerator.__init__"></a>
<h4>PyDocstringGenerator (Constructor)</h4>
<b>PyDocstringGenerator</b>(<i>editor</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -138,10 +136,10 @@
<a NAME="PyDocstringGenerator.__generateDocstring" ID="PyDocstringGenerator.__generateDocstring"></a>
<h4>PyDocstringGenerator.__generateDocstring</h4>
<b>__generateDocstring</b>(<i>quote, functionDef, bodyStartLine</i>)
-
<p>
Private method to generate the list of docstring lines.
</p>
+
<dl>
<dt><i>quote</i> (str)</dt>
@@ -172,11 +170,11 @@
<a NAME="PyDocstringGenerator.__generateDocstringFromBelow" ID="PyDocstringGenerator.__generateDocstringFromBelow"></a>
<h4>PyDocstringGenerator.__generateDocstringFromBelow</h4>
<b>__generateDocstringFromBelow</b>(<i>cursorPosition</i>)
-
<p>
Private method to generate a docstring when the given position is on
the line below the end of the definition.
</p>
+
<dl>
<dt><i>cursorPosition</i> (tuple of (int, int))</dt>
@@ -200,11 +198,11 @@
<a NAME="PyDocstringGenerator.__generateDocstringFromStart" ID="PyDocstringGenerator.__generateDocstringFromStart"></a>
<h4>PyDocstringGenerator.__generateDocstringFromStart</h4>
<b>__generateDocstringFromStart</b>(<i></i>)
-
<p>
Private method to generate a docstring based on the cursor being
placed on the first line of the definition.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -221,10 +219,10 @@
<a NAME="PyDocstringGenerator.__getFunctionBody" ID="PyDocstringGenerator.__getFunctionBody"></a>
<h4>PyDocstringGenerator.__getFunctionBody</h4>
<b>__getFunctionBody</b>(<i>functionIndent, startLine</i>)
-
<p>
Private method to get the function body.
</p>
+
<dl>
<dt><i>functionIndent</i> (str)</dt>
@@ -251,11 +249,11 @@
<a NAME="PyDocstringGenerator.__getFunctionDefinitionFromBelow" ID="PyDocstringGenerator.__getFunctionDefinitionFromBelow"></a>
<h4>PyDocstringGenerator.__getFunctionDefinitionFromBelow</h4>
<b>__getFunctionDefinitionFromBelow</b>(<i>cursorPosition</i>)
-
<p>
Private method to extract the function definition based on the cursor
being placed on the first line after the definition.
</p>
+
<dl>
<dt><i>cursorPosition</i> (tuple of (int, int))</dt>
@@ -278,11 +276,11 @@
<a NAME="PyDocstringGenerator.__getFunctionDefinitionFromStart" ID="PyDocstringGenerator.__getFunctionDefinitionFromStart"></a>
<h4>PyDocstringGenerator.__getFunctionDefinitionFromStart</h4>
<b>__getFunctionDefinitionFromStart</b>(<i></i>)
-
<p>
Private method to extract the function definition based on the cursor
being placed on the first line of the definition.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -298,10 +296,10 @@
<a NAME="PyDocstringGenerator.__getIndentationInsertString" ID="PyDocstringGenerator.__getIndentationInsertString"></a>
<h4>PyDocstringGenerator.__getIndentationInsertString</h4>
<b>__getIndentationInsertString</b>(<i>text</i>)
-
<p>
Private method to create the indentation string for the docstring.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -324,11 +322,11 @@
<a NAME="PyDocstringGenerator.__isTripleQuotesStart" ID="PyDocstringGenerator.__isTripleQuotesStart"></a>
<h4>PyDocstringGenerator.__isTripleQuotesStart</h4>
<b>__isTripleQuotesStart</b>(<i>text</i>)
-
<p>
Private method to test, if the given text is the start of a triple
quoted string.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -351,11 +349,11 @@
<a NAME="PyDocstringGenerator.hasFunctionDefinition" ID="PyDocstringGenerator.hasFunctionDefinition"></a>
<h4>PyDocstringGenerator.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>
@@ -378,11 +376,11 @@
<a NAME="PyDocstringGenerator.insertDocstring" ID="PyDocstringGenerator.insertDocstring"></a>
<h4>PyDocstringGenerator.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>
@@ -398,11 +396,11 @@
<a NAME="PyDocstringGenerator.insertDocstringFromShortcut" ID="PyDocstringGenerator.insertDocstringFromShortcut"></a>
<h4>PyDocstringGenerator.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>
@@ -413,11 +411,11 @@
<a NAME="PyDocstringGenerator.isDocstringIntro" ID="PyDocstringGenerator.isDocstringIntro"></a>
<h4>PyDocstringGenerator.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>
@@ -440,11 +438,11 @@
<a NAME="PyDocstringGenerator.isFunctionStart" ID="PyDocstringGenerator.isFunctionStart"></a>
<h4>PyDocstringGenerator.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>
@@ -470,26 +468,24 @@
<hr />
<a NAME="PyFunctionInfo" ID="PyFunctionInfo"></a>
<h2>PyFunctionInfo</h2>
-
<p>
Class implementing an object to extract and store function information.
</p>
+
<h3>Derived from</h3>
FunctionInfo
<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="#PyFunctionInfo.__init__">PyFunctionInfo</a></td>
<td>Constructor</td>
@@ -523,23 +519,23 @@
<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="PyFunctionInfo.__init__" ID="PyFunctionInfo.__init__"></a>
<h4>PyFunctionInfo (Constructor)</h4>
<b>PyFunctionInfo</b>(<i></i>)
-
<p>
Constructor
</p>
+
<a NAME="PyFunctionInfo.__findBracketPosition" ID="PyFunctionInfo.__findBracketPosition"></a>
<h4>PyFunctionInfo.__findBracketPosition</h4>
<b>__findBracketPosition</b>(<i>text, bracketLeft, bracketRight, posQuote</i>)
-
<p>
Private method to find the start and end position of pairs of brackets.
</p>
@@ -547,6 +543,7 @@
https://stackoverflow.com/questions/29991917/
indices-of-matching-parentheses-in-python
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -590,10 +587,10 @@
<a NAME="PyFunctionInfo.__findQuotePosition" ID="PyFunctionInfo.__findQuotePosition"></a>
<h4>PyFunctionInfo.__findQuotePosition</h4>
<b>__findQuotePosition</b>(<i>text</i>)
-
<p>
Private method to find the start and end position of pairs of quotes.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -623,11 +620,11 @@
<a NAME="PyFunctionInfo.__isCharInPairs" ID="PyFunctionInfo.__isCharInPairs"></a>
<h4>PyFunctionInfo.__isCharInPairs</h4>
<b>__isCharInPairs</b>(<i>posChar, pairs</i>)
-
<p>
Private method to test, if the given character position is between
pairs of brackets or quotes.
</p>
+
<dl>
<dt><i>posChar</i> (int)</dt>
@@ -654,10 +651,10 @@
<a NAME="PyFunctionInfo.__splitArgumentToNameTypeValue" ID="PyFunctionInfo.__splitArgumentToNameTypeValue"></a>
<h4>PyFunctionInfo.__splitArgumentToNameTypeValue</h4>
<b>__splitArgumentToNameTypeValue</b>(<i>argumentsList, quote, quoteReplace</i>)
-
<p>
Private method to split some argument text to name, type and value.
</p>
+
<dl>
<dt><i>argumentsList</i> (list of str)</dt>
@@ -676,7 +673,6 @@
<a NAME="PyFunctionInfo.__splitArgumentsTextToList" ID="PyFunctionInfo.__splitArgumentsTextToList"></a>
<h4>PyFunctionInfo.__splitArgumentsTextToList</h4>
<b>__splitArgumentsTextToList</b>(<i>argumentsText</i>)
-
<p>
Private method to split the given arguments text into a list of
arguments.
@@ -685,6 +681,7 @@
This function uses a comma to separate arguments and ignores a comma in
brackets and quotes.
</p>
+
<dl>
<dt><i>argumentsText</i> (str)</dt>
@@ -707,10 +704,10 @@
<a NAME="PyFunctionInfo.parseBody" ID="PyFunctionInfo.parseBody"></a>
<h4>PyFunctionInfo.parseBody</h4>
<b>parseBody</b>(<i>text</i>)
-
<p>
Public method to parse the function body text.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -721,10 +718,10 @@
<a NAME="PyFunctionInfo.parseDefinition" ID="PyFunctionInfo.parseDefinition"></a>
<h4>PyFunctionInfo.parseDefinition</h4>
<b>parseDefinition</b>(<i>text, quote, quoteReplace</i>)
-
<p>
Public method to parse the function definition text.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -742,4 +739,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
