Fri, 22 Dec 2023 19:45:17 +0100
Converted some source code documentation to the new style.
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html Fri Dec 22 19:45:17 2023 +0100 @@ -118,9 +118,9 @@ </p> <dl> -<dt><i>options</i></dt> +<dt><i>options</i> (optparse.Values)</dt> <dd> -options for the report (optparse.Values) +options for the report </dd> </dl> <a NAME="CodeStyleCheckerReport.error_args" ID="CodeStyleCheckerReport.error_args"></a> @@ -132,31 +132,37 @@ </p> <dl> -<dt><i>line_number</i></dt> +<dt><i>line_number</i> (int)</dt> <dd> -line number of the issue (integer) +line number of the issue </dd> -<dt><i>offset</i></dt> +<dt><i>offset</i> (int)</dt> <dd> -position within line of the issue (integer) +position within line of the issue </dd> -<dt><i>errorCode</i></dt> +<dt><i>errorCode</i> (str)</dt> <dd> -error message code (string) +error message code </dd> -<dt><i>check</i></dt> +<dt><i>check</i> (function)</dt> <dd> -reference to the checker function (function) +reference to the checker function </dd> -<dt><i>args</i></dt> +<dt><i>args</i> (list)</dt> <dd> -arguments for the message (list) +arguments for the message </dd> </dl> <dl> <dt>Return:</dt> <dd> -error code (string) +error code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -343,27 +349,33 @@ </p> <dl> -<dt><i>line</i></dt> +<dt><i>line</i> (str)</dt> <dd> -line to extract flags from (string) +line to extract flags from </dd> -<dt><i>startComment</i></dt> +<dt><i>startComment</i> (str)</dt> <dd> -string identifying the start of the comment (string) +string identifying the start of the comment </dd> -<dt><i>endComment</i></dt> +<dt><i>endComment</i> (str)</dt> <dd> -string identifying the end of a comment (string) +string identifying the end of a comment </dd> -<dt><i>flagsLine</i></dt> +<dt><i>flagsLine</i> (bool)</dt> <dd> -flag indicating to check for a flags only line (bool) +flag indicating to check for a flags only line </dd> </dl> <dl> <dt>Return:</dt> <dd> -list containing the extracted flags (list of strings) +list containing the extracted flags +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -412,7 +424,13 @@ <dl> <dt>Return:</dt> <dd> -the entry point for the background client (function) +the entry point for the background client +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +function </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -428,7 +446,13 @@ <dl> <dt>Return:</dt> <dd> -the entry point for the background client (function) +the entry point for the background client +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +function </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -476,13 +500,13 @@ </p> <dl> -<dt><i>inputQueue</i></dt> +<dt><i>inputQueue</i> (multiprocessing.Queue)</dt> <dd> -input queue (multiprocessing.Queue) +input queue </dd> -<dt><i>outputQueue</i></dt> +<dt><i>outputQueue</i> (multiprocessing.Queue)</dt> <dd> -output queue (multiprocessing.Queue) +output queue </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html Fri Dec 22 19:45:17 2023 +0100 @@ -349,15 +349,21 @@ </p> <dl> -<dt><i>code</i></dt> -<dd> -to check (string) +<dt><i>code</i> (str)</dt> +<dd> +to check </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating it should be fixed (boolean) +flag indicating it should be fixed +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="CodeStyleFixer.__findLogical" ID="CodeStyleFixer.__findLogical"></a> @@ -375,6 +381,12 @@ of lines </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of ([int, int], [int, int]) +</dd> +</dl> <a NAME="CodeStyleFixer.__fixBlankLinesBefore" ID="CodeStyleFixer.__fixBlankLinesBefore"></a> <h4>CodeStyleFixer.__fixBlankLinesBefore</h4> <b>__fixBlankLinesBefore</b>(<i>code, line, pos, apply=False</i>) @@ -1905,15 +1917,15 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -line number of the issue (integer) -</dd> -<dt><i>pos</i></dt> -<dd> -position inside line (integer) -</dd> -<dt><i>logical</i></dt> +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line +</dd> +<dt><i>logical</i> (str)</dt> <dd> logical line structure </dd> @@ -1921,7 +1933,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating a change was done (boolean) +flag indicating a change was done +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <dl> @@ -2096,17 +2114,17 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -line to be corrected (string) -</dd> -<dt><i>offset</i></dt> -<dd> -offset within line (integer) -</dd> -<dt><i>replacement</i></dt> -<dd> -replacement string (string) +<dt><i>line</i> (str)</dt> +<dd> +line to be corrected +</dd> +<dt><i>offset</i> (int)</dt> +<dd> +offset within line +</dd> +<dt><i>replacement</i> (str)</dt> +<dd> +replacement string </dd> </dl> <dl> @@ -2115,6 +2133,12 @@ corrected line </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> <a NAME="CodeStyleFixer.__getID" ID="CodeStyleFixer.__getID"></a> <h4>CodeStyleFixer.__getID</h4> <b>__getID</b>(<i></i>) @@ -2125,7 +2149,13 @@ <dl> <dt>Return:</dt> <dd> -ID for a deferred fix (integer) +ID for a deferred fix +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="CodeStyleFixer.__getIndent" ID="CodeStyleFixer.__getIndent"></a> @@ -2137,15 +2167,21 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -line to determine the indentation string from (string) +<dt><i>line</i> (str)</dt> +<dd> +line to determine the indentation string from </dd> </dl> <dl> <dt>Return:</dt> <dd> -indentation string (string) +indentation string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="CodeStyleFixer.__getIndentWord" ID="CodeStyleFixer.__getIndentWord"></a> @@ -2158,7 +2194,13 @@ <dl> <dt>Return:</dt> <dd> -string to be used for an indentation (string) +string to be used for an indentation +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="CodeStyleFixer.__getLogical" ID="CodeStyleFixer.__getLogical"></a> @@ -2171,13 +2213,13 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -line number of the issue (integer) -</dd> -<dt><i>pos</i></dt> -<dd> -position inside line (integer) +<dt><i>line</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position inside line </dd> </dl> <dl> @@ -2189,6 +2231,12 @@ source lines </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of ((int, int), (int, int), [str]) +</dd> +</dl> <a NAME="CodeStyleFixer.__multilineStringLines" ID="CodeStyleFixer.__multilineStringLines"></a> <h4>CodeStyleFixer.__multilineStringLines</h4> <b>__multilineStringLines</b>(<i></i>) @@ -2202,7 +2250,13 @@ <dd> tuple of a set of line numbers belonging to a multi line string and a set of line numbers belonging to a multi line - documentation string (tuple of two set of integer) + documentation string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (set of int, set of int) </dd> </dl> <a NAME="CodeStyleFixer.finalize" ID="CodeStyleFixer.finalize"></a> @@ -2218,6 +2272,12 @@ dictionary containing the fix results </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <a NAME="CodeStyleFixer.fixIssue" ID="CodeStyleFixer.fixIssue"></a> <h4>CodeStyleFixer.fixIssue</h4> <b>fixIssue</b>(<i>line, pos, code</i>) @@ -2266,7 +2326,12 @@ <dt>Return:</dt> <dd> flag indicating that one string starts with the other - (boolean) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="CodeStyleFixer.saveFile" ID="CodeStyleFixer.saveFile"></a> @@ -2278,15 +2343,21 @@ </p> <dl> -<dt><i>encoding</i></dt> -<dd> -encoding of the source file (string) +<dt><i>encoding</i> (str)</dt> +<dd> +encoding of the source file </dd> </dl> <dl> <dt>Return:</dt> <dd> -error message on failure (tuple of str) +error message on failure +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, [str]) </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -2345,10 +2416,9 @@ </p> <dl> -<dt><i>physical_lines</i></dt> +<dt><i>physical_lines</i> (list of str)</dt> <dd> list of physical lines to operate on - (list of strings) </dd> </dl> <a NAME="IndentationWrapper.__buildTokensLogical" ID="IndentationWrapper.__buildTokensLogical"></a> @@ -2360,7 +2430,7 @@ </p> <dl> -<dt><i>tokens</i></dt> +<dt><i>tokens</i> (list of Token)</dt> <dd> list of tokens as generated by tokenize.generate_tokens </dd> @@ -2368,7 +2438,13 @@ <dl> <dt>Return:</dt> <dd> -logical line (string) +logical line +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="IndentationWrapper.pep8Expected" ID="IndentationWrapper.pep8Expected"></a> @@ -2383,8 +2459,14 @@ <dt>Return:</dt> <dd> list of lists, where each list represents valid indent levels - for the line in question, relative from the initial indent. However, - the first entry is the indent level which was expected. + for the line in question, relative from the initial indent. However, + the first entry is the indent level which was expected. +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of list </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -2472,34 +2554,34 @@ </p> <dl> -<dt><i>curLine</i></dt> -<dd> -text to work on (string) -</dd> -<dt><i>prevLine</i></dt> -<dd> -line before the text to work on (string) -</dd> -<dt><i>nextLine</i></dt> -<dd> -line after the text to work on (string) -</dd> -<dt><i>maxLength</i></dt> -<dd> -maximum allowed line length (integer) -</dd> -<dt><i>eol</i></dt> -<dd> -eond-of-line marker (string) -</dd> -<dt><i>indentWord</i></dt> -<dd> -string used for indentation (string) -</dd> -<dt><i>isDocString</i></dt> +<dt><i>curLine</i> (str)</dt> +<dd> +text to work on +</dd> +<dt><i>prevLine</i> (str)</dt> +<dd> +line before the text to work on +</dd> +<dt><i>nextLine</i> (str)</dt> +<dd> +line after the text to work on +</dd> +<dt><i>maxLength</i> (int)</dt> +<dd> +maximum allowed line length +</dd> +<dt><i>eol</i> (str)</dt> +<dd> +eond-of-line marker +</dd> +<dt><i>indentWord</i> (str)</dt> +<dd> +string used for indentation +</dd> +<dt><i>isDocString</i> (bool)</dt> <dd> flag indicating that the line belongs to - a documentation string (boolean) + a documentation string </dd> </dl> <a NAME="LineShortener.__breakMultiline" ID="LineShortener.__breakMultiline"></a> @@ -2513,7 +2595,12 @@ <dt>Return:</dt> <dd> tuple of the shortened line and the changed next line - (string, string) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str) </dd> </dl> <a NAME="LineShortener.__checkSyntax" ID="LineShortener.__checkSyntax"></a> @@ -2525,15 +2612,21 @@ </p> <dl> -<dt><i>code</i></dt> -<dd> -code fragment to check (string) +<dt><i>code</i> (str)</dt> +<dd> +code fragment to check </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating syntax is ok (boolean) +flag indicating syntax is ok +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="LineShortener.__countUnbalancedBrackets" ID="LineShortener.__countUnbalancedBrackets"></a> @@ -2546,15 +2639,21 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -line to work at (string) +<dt><i>line</i> (str)</dt> +<dd> +line to work at </dd> </dl> <dl> <dt>Return:</dt> <dd> -number of unmatched open/close brackets (integer) +number of unmatched open/close brackets +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="LineShortener.__getIndent" ID="LineShortener.__getIndent"></a> @@ -2566,15 +2665,21 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -line to determine the indentation string from (string) +<dt><i>line</i> (str)</dt> +<dd> +line to determine the indentation string from </dd> </dl> <dl> <dt>Return:</dt> <dd> -indentation string (string) +indentation string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="LineShortener.__isProbablyInsideStringOrComment" ID="LineShortener.__isProbablyInsideStringOrComment"></a> @@ -2587,13 +2692,13 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -line to check (string) -</dd> -<dt><i>index</i></dt> -<dd> -position inside line to check (integer) +<dt><i>line</i> (str)</dt> +<dd> +line to check +</dd> +<dt><i>index</i> (int)</dt> +<dd> +position inside line to check </dd> </dl> <dl> @@ -2603,6 +2708,12 @@ or comment </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="LineShortener.__lineShorteningRank" ID="LineShortener.__lineShorteningRank"></a> <h4>LineShortener.__lineShorteningRank</h4> <b>__lineShorteningRank</b>(<i>candidate</i>) @@ -2612,15 +2723,21 @@ </p> <dl> -<dt><i>candidate</i></dt> -<dd> -candidate line to rank (string) +<dt><i>candidate</i> (str)</dt> +<dd> +candidate line to rank </dd> </dl> <dl> <dt>Return:</dt> <dd> -rank of the candidate (integer) +rank of the candidate +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="LineShortener.__normalizeMultiline" ID="LineShortener.__normalizeMultiline"></a> @@ -2633,15 +2750,21 @@ </p> <dl> -<dt><i>text</i></dt> -<dd> -code line to work on (string) +<dt><i>text</i> (str)</dt> +<dd> +code line to work on </dd> </dl> <dl> <dt>Return:</dt> <dd> -normalized code line (string) +normalized code line +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="LineShortener.__shortenComment" ID="LineShortener.__shortenComment"></a> @@ -2653,16 +2776,21 @@ </p> <dl> -<dt><i>isLast</i></dt> +<dt><i>isLast</i> (bool)</dt> <dd> flag indicating, that the line is the last comment line - (boolean) </dd> </dl> <dl> <dt>Return:</dt> <dd> -shortened comment line (string) +shortened comment line +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="LineShortener.__shortenLine" ID="LineShortener.__shortenLine"></a> @@ -2674,24 +2802,29 @@ </p> <dl> -<dt><i>tokens</i></dt> +<dt><i>tokens</i> (list of Token)</dt> <dd> tokens of the line as generated by tokenize - (list of token) -</dd> -<dt><i>source</i></dt> -<dd> -code string to work at (string) -</dd> -<dt><i>indent</i></dt> -<dd> -indentation string of the code line (string) +</dd> +<dt><i>source</i> (str)</dt> +<dd> +code string to work at +</dd> +<dt><i>indent</i> (str)</dt> +<dd> +indentation string of the code line </dd> </dl> <dl> <dt>Return:</dt> <dd> -list of candidates (list of string) +list of candidates +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="LineShortener.shorten" ID="LineShortener.shorten"></a> @@ -2705,7 +2838,13 @@ <dt>Return:</dt> <dd> tuple of a flag indicating successful shortening, the - shortened line and the changed next line (boolean, string, string) + shortened line and the changed next line +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str, str) </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -2777,10 +2916,9 @@ </p> <dl> -<dt><i>sourceLines</i></dt> +<dt><i>sourceLines</i> (list of str)</dt> <dd> list of source lines including eol marker - (list of string) </dd> </dl> <a NAME="Reindenter.__genStats" ID="Reindenter.__genStats"></a> @@ -2792,7 +2930,7 @@ </p> <dl> -<dt><i>tokens</i></dt> +<dt><i>tokens</i> (function)</dt> <dd> tokens generator (tokenize._tokenize) </dd> @@ -2803,6 +2941,12 @@ reference to the generated statistics </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <a NAME="Reindenter.__getlspace" ID="Reindenter.__getlspace"></a> <h4>Reindenter.__getlspace</h4> <b>__getlspace</b>(<i>line</i>) @@ -2812,15 +2956,21 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -line to check (string) +<dt><i>line</i> (str)</dt> +<dd> +line to check </dd> </dl> <dl> <dt>Return:</dt> <dd> -number of leading blanks (integer) +number of leading blanks +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="Reindenter.fixedLine" ID="Reindenter.fixedLine"></a> @@ -2832,15 +2982,21 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -number of the line to retrieve (integer) +<dt><i>line</i> (int)</dt> +<dd> +number of the line to retrieve </dd> </dl> <dl> <dt>Return:</dt> <dd> -fixed line (string) +fixed line +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Reindenter.getline" ID="Reindenter.getline"></a> @@ -2853,7 +3009,13 @@ <dl> <dt>Return:</dt> <dd> -line of text (string) +line of text +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Reindenter.run" ID="Reindenter.run"></a> @@ -2866,7 +3028,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating that a change was done (boolean) +flag indicating that a change was done +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html Fri Dec 22 19:45:17 2023 +0100 @@ -1980,7 +1980,7 @@ </p> <dl> -<dt><i>node</i></dt> +<dt><i>node</i> (ast.Dict)</dt> <dd> reference to the AST node </dd> @@ -2120,6 +2120,12 @@ flag indicating an implicit string concatenation </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="MiscellaneousChecker.run" ID="MiscellaneousChecker.run"></a> <h4>MiscellaneousChecker.run</h4> <b>run</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html Fri Dec 22 19:45:17 2023 +0100 @@ -170,15 +170,15 @@ </p> <dl> -<dt><i>tree</i></dt> +<dt><i>tree</i> (ast.AST)</dt> <dd> AST tree of the source file </dd> -<dt><i>filename</i></dt> +<dt><i>filename</i> (str)</dt> <dd> -name of the source file (string) +name of the source file </dd> -<dt><i>options</i></dt> +<dt><i>options</i> (optparse.Option)</dt> <dd> options as parsed by pycodestyle.StyleGuide </dd> @@ -197,11 +197,11 @@ </p> <dl> -<dt><i>node</i></dt> +<dt><i>node</i> (ast.ClassDef)</dt> <dd> AST note to check </dd> -<dt><i>parents</i></dt> +<dt><i>parents</i> (list of ast.AST)</dt> <dd> list of parent nodes </dd> @@ -233,11 +233,11 @@ </p> <dl> -<dt><i>node</i></dt> +<dt><i>node</i> (ast.FunctionDef or ast.AsynFunctionDef)</dt> <dd> AST note to check </dd> -<dt><i>parents</i></dt> +<dt><i>parents</i> (list of ast.AST)</dt> <dd> list of parent nodes </dd> @@ -271,11 +271,11 @@ </p> <dl> -<dt><i>node</i></dt> +<dt><i>node</i> (ast.FunctionDef or ast.AsynFunctionDef)</dt> <dd> AST note to check </dd> -<dt><i>parents</i></dt> +<dt><i>parents</i> (list of ast.AST)</dt> <dd> list of parent nodes </dd> @@ -302,11 +302,11 @@ </p> <dl> -<dt><i>node</i></dt> +<dt><i>node</i> (ast.Import)</dt> <dd> -AST note to check +AST node to check </dd> -<dt><i>parents</i></dt> +<dt><i>parents</i> (list of ast.AST)</dt> <dd> list of parent nodes </dd> @@ -335,11 +335,11 @@ </p> <dl> -<dt><i>node</i></dt> +<dt><i>node</i> (ast.AST)</dt> <dd> -AST note to check +AST node to check </dd> -<dt><i>parents</i></dt> +<dt><i>parents</i> (list of ast.AST)</dt> <dd> list of parent nodes </dd> @@ -365,11 +365,11 @@ </p> <dl> -<dt><i>node</i></dt> +<dt><i>node</i> (ast.Ast)</dt> <dd> AST note to check </dd> -<dt><i>parents</i></dt> +<dt><i>parents</i> (list of ast.AST)</dt> <dd> list of parent nodes </dd> @@ -399,11 +399,11 @@ </p> <dl> -<dt><i>node</i></dt> +<dt><i>node</i> (ast.AST)</dt> <dd> AST note to check </dd> -<dt><i>parents</i></dt> +<dt><i>parents</i> (list of ast.AST)</dt> <dd> list of parent nodes </dd> @@ -455,20 +455,25 @@ </p> <dl> -<dt><i>node</i></dt> +<dt><i>node</i> (ast.AST)</dt> <dd> AST node to report an error for </dd> -<dt><i>code</i></dt> +<dt><i>code</i> (str)</dt> <dd> -error code to report (string) +error code to report </dd> </dl> <dl> <dt>Return:</dt> <dd> tuple giving line number, offset within line and error code - (integer, integer, string) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, int, str) </dd> </dl> <a NAME="NamingStyleChecker.__extractNames" ID="NamingStyleChecker.__extractNames"></a> @@ -506,7 +511,7 @@ </p> <dl> -<dt><i>functionNode</i></dt> +<dt><i>functionNode</i> (ast.FunctionDef or ast.AsyncFunctionDef)</dt> <dd> AST tree node to amend </dd> @@ -580,7 +585,7 @@ </p> <dl> -<dt><i>node</i></dt> +<dt><i>node</i> (ast.FunctionDef or ast.AsyncFunctionDef)</dt> <dd> AST node to extract arguments names from </dd> @@ -588,7 +593,13 @@ <dl> <dt>Return:</dt> <dd> -list of argument names (list of string) +list of argument names +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="NamingStyleChecker.__getClassdef" ID="NamingStyleChecker.__getClassdef"></a> @@ -604,7 +615,7 @@ <dd> name of the class </dd> -<dt><i>parents</i> (ast.AST)</dt> +<dt><i>parents</i> (list of ast.AST)</dt> <dd> list of parent nodes </dd> @@ -682,15 +693,21 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name to be checked (string) +name to be checked </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating to avoid it (boolen) +flag indicating to avoid it +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="NamingStyleChecker.__isNamedTupel" ID="NamingStyleChecker.__isNamedTupel"></a> @@ -732,7 +749,7 @@ <dd> name of the class </dd> -<dt><i>parents</i> (ast.AST)</dt> +<dt><i>parents</i> (list of ast.AST)</dt> <dd> list of parent nodes </dd> @@ -763,7 +780,7 @@ </p> <dl> -<dt><i>classNode</i></dt> +<dt><i>classNode</i> (ast.ClassDef)</dt> <dd> AST tree node to tag </dd> @@ -777,7 +794,7 @@ </p> <dl> -<dt><i>node</i></dt> +<dt><i>node</i> (ast.AST)</dt> <dd> AST tree node to inspect </dd> @@ -803,7 +820,7 @@ </p> <dl> -<dt><i>node</i></dt> +<dt><i>node</i> (ast.AST)</dt> <dd> AST tree node to scan </dd> @@ -834,6 +851,12 @@ checker function </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, int, str, function) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -114,15 +114,15 @@ </p> <dl> -<dt><i>project</i></dt> +<dt><i>project</i> (Project)</dt> <dd> -reference to the project object (Project.Project) +reference to the project object </dd> -<dt><i>parms</i></dt> +<dt><i>parms</i> (dict)</dt> <dd> parameters to set in the dialog </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> parent widget of this dialog </dd> @@ -237,9 +237,9 @@ </p> <dl> -<dt><i>filename</i></dt> +<dt><i>filename</i> (str)</dt> <dd> -name of the file (string) +name of the file </dd> </dl> <a NAME="EricapiConfigDialog.on_startDirPicker_pathSelected" ID="EricapiConfigDialog.on_startDirPicker_pathSelected"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericapi.EricapiExecDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericapi.EricapiExecDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -106,13 +106,13 @@ </p> <dl> -<dt><i>cmdname</i></dt> +<dt><i>cmdname</i> (str)</dt> <dd> -name of the ericapi generator (string) +name of the ericapi generator </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget of this dialog (QWidget) +parent widget of this dialog </dd> </dl> <a NAME="EricapiExecDialog.__finish" ID="EricapiExecDialog.__finish"></a> @@ -157,9 +157,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="EricapiExecDialog.start" ID="EricapiExecDialog.start"></a> @@ -171,20 +171,25 @@ </p> <dl> -<dt><i>args</i></dt> +<dt><i>args</i> (list of str)</dt> <dd> -commandline arguments for ericapi program (list of strings) +commandline arguments for ericapi program </dd> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> filename or dirname to be processed by ericapi program - (string) </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating the successful start of the process (boolean) +flag indicating the successful start of the process +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -174,15 +174,15 @@ </p> <dl> -<dt><i>project</i></dt> +<dt><i>project</i> (Project)</dt> <dd> -reference to the project object (Project.Project) +reference to the project object </dd> -<dt><i>parms</i></dt> +<dt><i>parms</i> (dict)</dt> <dd> parameters to set in the dialog </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> parent widget of this dialog </dd> @@ -215,9 +215,9 @@ </p> <dl> -<dt><i>colorKey</i></dt> +<dt><i>colorKey</i> (str)</dt> <dd> -key of the color to select (string) +key of the color to select </dd> </dl> <a NAME="EricdocConfigDialog.accept" ID="EricdocConfigDialog.accept"></a> @@ -404,9 +404,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the line edit (string) +text of the line edit </dd> </dl> <a NAME="EricdocConfigDialog.on_qtHelpGroup_toggled" ID="EricdocConfigDialog.on_qtHelpGroup_toggled"></a> @@ -418,9 +418,9 @@ </p> <dl> -<dt><i>enabled</i></dt> +<dt><i>enabled</i> (bool)</dt> <dd> -flag indicating the state (boolean) +flag indicating the state </dd> </dl> <a NAME="EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged"></a> @@ -432,9 +432,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the line edit (string) +text of the line edit </dd> </dl> <a NAME="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged"></a> @@ -446,9 +446,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the line edit (string) +text of the line edit </dd> </dl> <a NAME="EricdocConfigDialog.on_startDirPicker_pathSelected" ID="EricdocConfigDialog.on_startDirPicker_pathSelected"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -106,13 +106,13 @@ </p> <dl> -<dt><i>cmdname</i></dt> +<dt><i>cmdname</i> (str)</dt> <dd> -name of the documentation generator (string) +name of the documentation generator </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget of this dialog (QWidget) +parent widget of this dialog </dd> </dl> <a NAME="EricdocExecDialog.__finish" ID="EricdocExecDialog.__finish"></a> @@ -157,9 +157,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="EricdocExecDialog.start" ID="EricdocExecDialog.start"></a> @@ -171,20 +171,25 @@ </p> <dl> -<dt><i>args</i></dt> +<dt><i>args</i> (list of str)</dt> <dd> -commandline arguments for ericdoc program (list of strings) +commandline arguments for ericdoc program </dd> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> filename or dirname to be processed by ericdoc program - (string) </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating the successful start of the process (boolean) +flag indicating the successful start of the process +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginAbout.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginAbout.html Fri Dec 22 19:45:17 2023 +0100 @@ -98,9 +98,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="AboutPlugin.__about" ID="AboutPlugin.__about"></a> @@ -141,7 +141,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of None and activation status (boolean) +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="AboutPlugin.deactivate" ID="AboutPlugin.deactivate"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginCodeStyleChecker.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginCodeStyleChecker.html Fri Dec 22 19:45:17 2023 +0100 @@ -163,9 +163,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="CodeStyleCheckerPlugin.__editorClosed" ID="CodeStyleCheckerPlugin.__editorClosed"></a> @@ -177,9 +177,9 @@ </p> <dl> -<dt><i>editor</i></dt> +<dt><i>editor</i> (Editor)</dt> <dd> -reference to the editor (QScintilla.Editor) +reference to the editor </dd> </dl> <a NAME="CodeStyleCheckerPlugin.__editorCodeStyleCheck" ID="CodeStyleCheckerPlugin.__editorCodeStyleCheck"></a> @@ -199,9 +199,9 @@ </p> <dl> -<dt><i>editor</i></dt> +<dt><i>editor</i> (Editor)</dt> <dd> -reference to the new editor (QScintilla.Editor) +reference to the new editor </dd> </dl> <a NAME="CodeStyleCheckerPlugin.__editorShowMenu" ID="CodeStyleCheckerPlugin.__editorShowMenu"></a> @@ -214,15 +214,15 @@ </p> <dl> -<dt><i>menuName</i></dt> +<dt><i>menuName</i> (str)</dt> <dd> -name of the menu to be shown (string) +name of the menu to be shown </dd> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> -reference to the menu (QMenu) +reference to the menu </dd> -<dt><i>editor</i></dt> +<dt><i>editor</i> (Editor)</dt> <dd> reference to the editor </dd> @@ -252,13 +252,13 @@ </p> <dl> -<dt><i>menuName</i></dt> +<dt><i>menuName</i> (str)</dt> <dd> -name of the menu to be shown (string) +name of the menu to be shown </dd> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> -reference to the menu (QMenu) +reference to the menu </dd> </dl> <a NAME="CodeStyleCheckerPlugin.__projectCodeStyleCheck" ID="CodeStyleCheckerPlugin.__projectCodeStyleCheck"></a> @@ -278,13 +278,13 @@ </p> <dl> -<dt><i>menuName</i></dt> +<dt><i>menuName</i> (str)</dt> <dd> -name of the menu to be shown (string) +name of the menu to be shown </dd> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> -reference to the menu (QMenu) +reference to the menu </dd> </dl> <a NAME="CodeStyleCheckerPlugin.__serviceError" ID="CodeStyleCheckerPlugin.__serviceError"></a> @@ -296,13 +296,13 @@ </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> -file name (string) +file name </dd> -<dt><i>msg</i></dt> +<dt><i>msg</i> (str)</dt> <dd> -message text (string) +message text </dd> </dl> <a NAME="CodeStyleCheckerPlugin.__translateStyleCheck" ID="CodeStyleCheckerPlugin.__translateStyleCheck"></a> @@ -338,7 +338,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of None and activation status (boolean) +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="CodeStyleCheckerPlugin.batchJobDone" ID="CodeStyleCheckerPlugin.batchJobDone"></a> @@ -350,13 +356,13 @@ </p> <dl> -<dt><i>fx</i></dt> +<dt><i>fx</i> (str)</dt> <dd> -service name (string) +service name </dd> -<dt><i>lang</i></dt> +<dt><i>lang</i> (str)</dt> <dd> -language (string) +language </dd> </dl> <a NAME="CodeStyleCheckerPlugin.cancelStyleBatchCheck" ID="CodeStyleCheckerPlugin.cancelStyleBatchCheck"></a> @@ -382,21 +388,21 @@ </p> <dl> -<dt><i>fx</i></dt> +<dt><i>fx</i> (str)</dt> <dd> -service name (string) +service name </dd> -<dt><i>lang</i></dt> +<dt><i>lang</i> (str)</dt> <dd> -language (string) +language </dd> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> -file name (string) +file name </dd> -<dt><i>msg</i></dt> +<dt><i>msg</i> (str)</dt> <dd> -message text (string) +message text </dd> </dl> <a NAME="CodeStyleCheckerPlugin.styleBatchCheck" ID="CodeStyleCheckerPlugin.styleBatchCheck"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginEricapi.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginEricapi.html Fri Dec 22 19:45:17 2023 +0100 @@ -106,9 +106,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="EricapiPlugin.__doEricapi" ID="EricapiPlugin.__doEricapi"></a> @@ -149,13 +149,13 @@ </p> <dl> -<dt><i>menuName</i></dt> +<dt><i>menuName</i> (str)</dt> <dd> -name of the menu to be shown (string) +name of the menu to be shown </dd> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> -reference to the menu (QMenu) +reference to the menu </dd> </dl> <a NAME="EricapiPlugin.activate" ID="EricapiPlugin.activate"></a> @@ -168,7 +168,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of None and activation status (boolean) +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="EricapiPlugin.deactivate" ID="EricapiPlugin.deactivate"></a> @@ -195,6 +201,12 @@ the executable </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginEricdoc.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginEricdoc.html Fri Dec 22 19:45:17 2023 +0100 @@ -106,9 +106,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="EricdocPlugin.__doEricdoc" ID="EricdocPlugin.__doEricdoc"></a> @@ -149,13 +149,13 @@ </p> <dl> -<dt><i>menuName</i></dt> +<dt><i>menuName</i> (str)</dt> <dd> -name of the menu to be shown (string) +name of the menu to be shown </dd> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> -reference to the menu (QMenu) +reference to the menu </dd> </dl> <a NAME="EricdocPlugin.activate" ID="EricdocPlugin.activate"></a> @@ -168,7 +168,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of None and activation status (boolean) +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="EricdocPlugin.deactivate" ID="EricdocPlugin.deactivate"></a> @@ -195,6 +201,12 @@ the executable </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsGit.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsGit.html Fri Dec 22 19:45:17 2023 +0100 @@ -138,7 +138,7 @@ </p> <dl> -<dt><i>key</i></dt> +<dt><i>key</i> (str)</dt> <dd> the key of the value to get </dd> @@ -149,6 +149,12 @@ the requested setting </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +Any +</dd> +</dl> <a NAME="VcsGitPlugin.setPreferences" ID="VcsGitPlugin.setPreferences"></a> <h4>VcsGitPlugin.setPreferences (class method)</h4> <b>setPreferences</b>(<i>key, value</i>) @@ -158,11 +164,11 @@ </p> <dl> -<dt><i>key</i></dt> +<dt><i>key</i> (str)</dt> <dd> the key of the setting to be set </dd> -<dt><i>value</i></dt> +<dt><i>value</i> (Any)</dt> <dd> the value to be set </dd> @@ -176,9 +182,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="VcsGitPlugin.activate" ID="VcsGitPlugin.activate"></a> @@ -191,8 +197,14 @@ <dl> <dt>Return:</dt> <dd> -tuple of reference to instantiated viewmanager and - activation status (boolean) +tuple of reference to instantiated version control and + activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (Git, bool) </dd> </dl> <a NAME="VcsGitPlugin.deactivate" ID="VcsGitPlugin.deactivate"></a> @@ -212,7 +224,13 @@ <dl> <dt>Return:</dt> <dd> -filename of the config file (string) +filename of the config file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="VcsGitPlugin.getProjectHelper" ID="VcsGitPlugin.getProjectHelper"></a> @@ -228,6 +246,12 @@ reference to the project helper object </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +GitProjectHelper +</dd> +</dl> <a NAME="VcsGitPlugin.initToolbar" ID="VcsGitPlugin.initToolbar"></a> <h4>VcsGitPlugin.initToolbar</h4> <b>initToolbar</b>(<i>ui, toolbarManager</i>) @@ -237,14 +261,13 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the main window (UserInterface) +reference to the main window </dd> -<dt><i>toolbarManager</i></dt> +<dt><i>toolbarManager</i> (EricToolBarManager)</dt> <dd> reference to a toolbar manager object - (EricToolBarManager) </dd> </dl> <a NAME="VcsGitPlugin.prepareUninstall" ID="VcsGitPlugin.prepareUninstall"></a> @@ -283,9 +306,9 @@ </p> <dl> -<dt><i>configDlg</i></dt> +<dt><i>configDlg</i> (QDialog)</dt> <dd> -reference to the configuration dialog (QDialog) +reference to the configuration dialog </dd> </dl> <dl> @@ -294,6 +317,12 @@ reference to the configuration page </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +GitPage +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -307,7 +336,13 @@ <dl> <dt>Return:</dt> <dd> -display string (string) +display string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -327,6 +362,12 @@ the executable </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -340,8 +381,13 @@ <dl> <dt>Return:</dt> <dd> -dictionary with key "zzz_gitPage" containing the relevant - data +dictionary with key "zzz_gitPage" containing the relevant data +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -358,7 +404,13 @@ <dt>Return:</dt> <dd> dictionary with indicator as key and a tuple with the vcs name - (string) and vcs display string (string) + and vcs display string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsMercurial.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsMercurial.html Fri Dec 22 19:45:17 2023 +0100 @@ -142,7 +142,7 @@ </p> <dl> -<dt><i>key</i></dt> +<dt><i>key</i> (str)</dt> <dd> the key of the value to get </dd> @@ -153,6 +153,12 @@ the requested setting </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +Any +</dd> +</dl> <a NAME="VcsMercurialPlugin.setPreferences" ID="VcsMercurialPlugin.setPreferences"></a> <h4>VcsMercurialPlugin.setPreferences (class method)</h4> <b>setPreferences</b>(<i>key, value</i>) @@ -162,11 +168,11 @@ </p> <dl> -<dt><i>key</i></dt> +<dt><i>key</i> (str)</dt> <dd> the key of the setting to be set </dd> -<dt><i>value</i></dt> +<dt><i>value</i> (Any)</dt> <dd> the value to be set </dd> @@ -180,9 +186,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="VcsMercurialPlugin.activate" ID="VcsMercurialPlugin.activate"></a> @@ -196,7 +202,13 @@ <dt>Return:</dt> <dd> tuple of reference to instantiated viewmanager and - activation status (boolean) + activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (Hg, bool) </dd> </dl> <a NAME="VcsMercurialPlugin.deactivate" ID="VcsMercurialPlugin.deactivate"></a> @@ -216,7 +228,13 @@ <dl> <dt>Return:</dt> <dd> -filename of the config file (string) +filename of the config file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="VcsMercurialPlugin.getGlobalOptions" ID="VcsMercurialPlugin.getGlobalOptions"></a> @@ -229,7 +247,13 @@ <dl> <dt>Return:</dt> <dd> -list of global options (list of string) +list of global options +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="VcsMercurialPlugin.getProjectHelper" ID="VcsMercurialPlugin.getProjectHelper"></a> @@ -245,6 +269,12 @@ reference to the project helper object </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +HgProjectHelper +</dd> +</dl> <a NAME="VcsMercurialPlugin.initToolbar" ID="VcsMercurialPlugin.initToolbar"></a> <h4>VcsMercurialPlugin.initToolbar</h4> <b>initToolbar</b>(<i>ui, toolbarManager</i>) @@ -254,14 +284,13 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the main window (UserInterface) +reference to the main window </dd> -<dt><i>toolbarManager</i></dt> +<dt><i>toolbarManager</i> (EricToolBarManager)</dt> <dd> reference to a toolbar manager object - (EricToolBarManager) </dd> </dl> <a NAME="VcsMercurialPlugin.prepareUninstall" ID="VcsMercurialPlugin.prepareUninstall"></a> @@ -300,9 +329,9 @@ </p> <dl> -<dt><i>configDlg</i></dt> +<dt><i>configDlg</i> (QDialog)</dt> <dd> -reference to the configuration dialog (QDialog) +reference to the configuration dialog </dd> </dl> <dl> @@ -311,6 +340,12 @@ reference to the configuration page </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +MercurialPage +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -324,7 +359,13 @@ <dl> <dt>Return:</dt> <dd> -display string (string) +display string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -344,6 +385,12 @@ the executable </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -357,8 +404,13 @@ <dl> <dt>Return:</dt> <dd> -dictionary with key "zzz_mercurialPage" containing the relevant - data +dictionary with key "zzz_mercurialPage" containing the relevant data +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -375,7 +427,13 @@ <dt>Return:</dt> <dd> dictionary with indicator as key and a tuple with the vcs name - (string) and vcs display string (string) + and vcs display string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsPySvn.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsPySvn.html Fri Dec 22 19:45:17 2023 +0100 @@ -138,9 +138,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="VcsPySvnPlugin.activate" ID="VcsPySvnPlugin.activate"></a> @@ -154,7 +154,13 @@ <dt>Return:</dt> <dd> tuple of reference to instantiated viewmanager and - activation status (boolean) + activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (Subversion, bool) </dd> </dl> <a NAME="VcsPySvnPlugin.deactivate" ID="VcsPySvnPlugin.deactivate"></a> @@ -174,7 +180,13 @@ <dl> <dt>Return:</dt> <dd> -filename of the config file (string) +filename of the config file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="VcsPySvnPlugin.getPreferences" ID="VcsPySvnPlugin.getPreferences"></a> @@ -186,7 +198,7 @@ </p> <dl> -<dt><i>key</i></dt> +<dt><i>key</i> (str)</dt> <dd> the key of the value to get </dd> @@ -197,6 +209,12 @@ the requested refactoring setting </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +Any +</dd> +</dl> <a NAME="VcsPySvnPlugin.getProjectHelper" ID="VcsPySvnPlugin.getProjectHelper"></a> <h4>VcsPySvnPlugin.getProjectHelper</h4> <b>getProjectHelper</b>(<i></i>) @@ -210,6 +228,12 @@ reference to the project helper object </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +PySvnProjectHelper +</dd> +</dl> <a NAME="VcsPySvnPlugin.getServersPath" ID="VcsPySvnPlugin.getServersPath"></a> <h4>VcsPySvnPlugin.getServersPath</h4> <b>getServersPath</b>(<i></i>) @@ -220,7 +244,13 @@ <dl> <dt>Return:</dt> <dd> -filename of the servers file (string) +filename of the servers file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="VcsPySvnPlugin.initToolbar" ID="VcsPySvnPlugin.initToolbar"></a> @@ -232,14 +262,13 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the main window (UserInterface) +reference to the main window </dd> -<dt><i>toolbarManager</i></dt> +<dt><i>toolbarManager</i> (EricToolBarManager)</dt> <dd> reference to a toolbar manager object - (EricToolBarManager) </dd> </dl> <a NAME="VcsPySvnPlugin.prepareUninstall" ID="VcsPySvnPlugin.prepareUninstall"></a> @@ -265,11 +294,11 @@ </p> <dl> -<dt><i>key</i></dt> +<dt><i>key</i> (str)</dt> <dd> the key of the setting to be set </dd> -<dt><i>value</i></dt> +<dt><i>value</i> (Any)</dt> <dd> the value to be set </dd> @@ -286,9 +315,9 @@ </p> <dl> -<dt><i>configDlg</i></dt> +<dt><i>configDlg</i> (QDialog)</dt> <dd> -reference to the configuration dialog (QDialog) +reference to the configuration dialog </dd> </dl> <dl> @@ -297,6 +326,12 @@ reference to the configuration page </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +SubversionPage +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -310,7 +345,13 @@ <dl> <dt>Return:</dt> <dd> -display string (string) +display string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -329,6 +370,12 @@ dictionary containing the data to be shown </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -346,6 +393,12 @@ data </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -360,7 +413,13 @@ <dt>Return:</dt> <dd> dictionary with indicator as key and a tuple with the vcs name - (string) and vcs display string (string) + and vcs display string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsSubversion.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsSubversion.html Fri Dec 22 19:45:17 2023 +0100 @@ -138,9 +138,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="VcsSubversionPlugin.activate" ID="VcsSubversionPlugin.activate"></a> @@ -154,7 +154,13 @@ <dt>Return:</dt> <dd> tuple of reference to instantiated viewmanager and - activation status (boolean) + activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (Subversion, bool) </dd> </dl> <a NAME="VcsSubversionPlugin.deactivate" ID="VcsSubversionPlugin.deactivate"></a> @@ -174,7 +180,13 @@ <dl> <dt>Return:</dt> <dd> -filename of the config file (string) +filename of the config file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="VcsSubversionPlugin.getPreferences" ID="VcsSubversionPlugin.getPreferences"></a> @@ -186,7 +198,7 @@ </p> <dl> -<dt><i>key</i></dt> +<dt><i>key</i> (str)</dt> <dd> the key of the value to get </dd> @@ -197,6 +209,12 @@ the requested setting </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +Any +</dd> +</dl> <a NAME="VcsSubversionPlugin.getProjectHelper" ID="VcsSubversionPlugin.getProjectHelper"></a> <h4>VcsSubversionPlugin.getProjectHelper</h4> <b>getProjectHelper</b>(<i></i>) @@ -210,6 +228,12 @@ reference to the project helper object </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +SvnProjectHelper +</dd> +</dl> <a NAME="VcsSubversionPlugin.getServersPath" ID="VcsSubversionPlugin.getServersPath"></a> <h4>VcsSubversionPlugin.getServersPath</h4> <b>getServersPath</b>(<i></i>) @@ -220,7 +244,13 @@ <dl> <dt>Return:</dt> <dd> -filename of the servers file (string) +filename of the servers file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="VcsSubversionPlugin.initToolbar" ID="VcsSubversionPlugin.initToolbar"></a> @@ -232,14 +262,13 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the main window (UserInterface) +reference to the main window </dd> -<dt><i>toolbarManager</i></dt> +<dt><i>toolbarManager</i> (EricToolBarManager)</dt> <dd> reference to a toolbar manager object - (EricToolBarManager) </dd> </dl> <a NAME="VcsSubversionPlugin.prepareUninstall" ID="VcsSubversionPlugin.prepareUninstall"></a> @@ -265,11 +294,11 @@ </p> <dl> -<dt><i>key</i></dt> +<dt><i>key</i> (str)</dt> <dd> the key of the setting to be set </dd> -<dt><i>value</i></dt> +<dt><i>value</i> (Any)</dt> <dd> the value to be set </dd> @@ -286,9 +315,9 @@ </p> <dl> -<dt><i>configDlg</i></dt> +<dt><i>configDlg</i> (QDialog)</dt> <dd> -reference to the configuration dialog (QDialog) +reference to the configuration dialog </dd> </dl> <dl> @@ -297,6 +326,12 @@ reference to the configuration page </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +SubversionPage +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -310,7 +345,13 @@ <dl> <dt>Return:</dt> <dd> -display string (string) +display string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -330,6 +371,12 @@ the executable </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -344,6 +391,12 @@ <dt>Return:</dt> <dd> dictionary with key "zzz_subversionPage" containing the relevant +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict data </dd> </dl> @@ -361,7 +414,13 @@ <dt>Return:</dt> <dd> dictionary with indicator as key and a tuple with the vcs name - (string) and vcs display string (string) + and vcs display string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginVmListspace.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginVmListspace.html Fri Dec 22 19:45:17 2023 +0100 @@ -86,9 +86,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="VmListspacePlugin.activate" ID="VmListspacePlugin.activate"></a> @@ -102,7 +102,13 @@ <dt>Return:</dt> <dd> tuple of reference to instantiated viewmanager and - activation status (boolean) + activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="VmListspacePlugin.deactivate" ID="VmListspacePlugin.deactivate"></a> @@ -125,7 +131,13 @@ <dl> <dt>Return:</dt> <dd> -preview pixmap (QPixmap) +preview pixmap +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QPixmap </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginVmTabview.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginVmTabview.html Fri Dec 22 19:45:17 2023 +0100 @@ -86,9 +86,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="VmTabviewPlugin.activate" ID="VmTabviewPlugin.activate"></a> @@ -102,7 +102,13 @@ <dt>Return:</dt> <dd> tuple of reference to instantiated viewmanager and - activation status (boolean) + activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="VmTabviewPlugin.deactivate" ID="VmTabviewPlugin.deactivate"></a> @@ -125,7 +131,13 @@ <dl> <dt>Return:</dt> <dd> -preview pixmap (QPixmap) +preview pixmap +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QPixmap </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardDotDesktop.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardDotDesktop.html Fri Dec 22 19:45:17 2023 +0100 @@ -98,9 +98,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="DotDesktopWizard.__handle" ID="DotDesktopWizard.__handle"></a> @@ -141,7 +141,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of None and activation status (boolean) +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="DotDesktopWizard.deactivate" ID="DotDesktopWizard.deactivate"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardEricMessageBox.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardEricMessageBox.html Fri Dec 22 19:45:17 2023 +0100 @@ -98,9 +98,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="EricMessageBoxWizard.__callForm" ID="EricMessageBoxWizard.__callForm"></a> @@ -112,7 +112,7 @@ </p> <dl> -<dt><i>editor</i></dt> +<dt><i>editor</i> (Editor)</dt> <dd> reference to the current editor </dd> @@ -120,7 +120,13 @@ <dl> <dt>Return:</dt> <dd> -the generated code (string) +the generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="EricMessageBoxWizard.__handle" ID="EricMessageBoxWizard.__handle"></a> @@ -154,7 +160,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of None and activation status (boolean) +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="EricMessageBoxWizard.deactivate" ID="EricMessageBoxWizard.deactivate"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardEricPlugin.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardEricPlugin.html Fri Dec 22 19:45:17 2023 +0100 @@ -102,9 +102,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="WizardEricPluginWizard.__callForm" ID="WizardEricPluginWizard.__callForm"></a> @@ -117,8 +117,13 @@ <dl> <dt>Return:</dt> <dd> -generated code (string), the plug-in package name (string) - and a flag indicating success (boolean) +generated code, the plug-in package name and a flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, bool) </dd> </dl> <a NAME="WizardEricPluginWizard.__handle" ID="WizardEricPluginWizard.__handle"></a> @@ -159,7 +164,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of None and activation status (boolean) +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="WizardEricPluginWizard.deactivate" ID="WizardEricPluginWizard.deactivate"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardPyRegExp.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardPyRegExp.html Fri Dec 22 19:45:17 2023 +0100 @@ -98,9 +98,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="PyRegExpWizard.__callForm" ID="PyRegExpWizard.__callForm"></a> @@ -112,7 +112,7 @@ </p> <dl> -<dt><i>editor</i></dt> +<dt><i>editor</i> (Editor)</dt> <dd> reference to the current editor </dd> @@ -120,7 +120,13 @@ <dl> <dt>Return:</dt> <dd> -the generated code (string) +the generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="PyRegExpWizard.__handle" ID="PyRegExpWizard.__handle"></a> @@ -154,7 +160,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of None and activation status (boolean) +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="PyRegExpWizard.deactivate" ID="PyRegExpWizard.deactivate"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardQColorDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardQColorDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -98,9 +98,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="ColorDialogWizard.__callForm" ID="ColorDialogWizard.__callForm"></a> @@ -112,7 +112,7 @@ </p> <dl> -<dt><i>editor</i></dt> +<dt><i>editor</i> (Editor)</dt> <dd> reference to the current editor </dd> @@ -120,7 +120,13 @@ <dl> <dt>Return:</dt> <dd> -the generated code (string) and a success flag (boolean) +the generated code and a success flag +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, bool) </dd> </dl> <a NAME="ColorDialogWizard.__handle" ID="ColorDialogWizard.__handle"></a> @@ -154,7 +160,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of None and activation status (boolean) +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="ColorDialogWizard.deactivate" ID="ColorDialogWizard.deactivate"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardQFileDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardQFileDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -106,9 +106,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="FileDialogWizard.__callForm" ID="FileDialogWizard.__callForm"></a> @@ -133,7 +133,13 @@ <dl> <dt>Return:</dt> <dd> -the generated code (string) +the generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="FileDialogWizard.__handle" ID="FileDialogWizard.__handle"></a> @@ -196,7 +202,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of None and activation status (boolean) +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="FileDialogWizard.deactivate" ID="FileDialogWizard.deactivate"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardQFontDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardQFontDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -98,9 +98,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="FontDialogWizard.__callForm" ID="FontDialogWizard.__callForm"></a> @@ -112,7 +112,7 @@ </p> <dl> -<dt><i>editor</i></dt> +<dt><i>editor</i> (Editor)</dt> <dd> reference to the current editor </dd> @@ -120,7 +120,13 @@ <dl> <dt>Return:</dt> <dd> -the generated code (string) +the generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="FontDialogWizard.__handle" ID="FontDialogWizard.__handle"></a> @@ -154,7 +160,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of None and activation status (boolean) +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="FontDialogWizard.deactivate" ID="FontDialogWizard.deactivate"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardQInputDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardQInputDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -98,9 +98,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="InputDialogWizard.__callForm" ID="InputDialogWizard.__callForm"></a> @@ -112,7 +112,7 @@ </p> <dl> -<dt><i>editor</i></dt> +<dt><i>editor</i> (Editor)</dt> <dd> reference to the current editor </dd> @@ -120,7 +120,13 @@ <dl> <dt>Return:</dt> <dd> -the generated code (string) +the generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="InputDialogWizard.__handle" ID="InputDialogWizard.__handle"></a> @@ -154,7 +160,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of None and activation status (boolean) +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="InputDialogWizard.deactivate" ID="InputDialogWizard.deactivate"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardQMessageBox.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardQMessageBox.html Fri Dec 22 19:45:17 2023 +0100 @@ -98,9 +98,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="MessageBoxWizard.__callForm" ID="MessageBoxWizard.__callForm"></a> @@ -112,7 +112,7 @@ </p> <dl> -<dt><i>editor</i></dt> +<dt><i>editor</i> (Editor)</dt> <dd> reference to the current editor </dd> @@ -120,7 +120,13 @@ <dl> <dt>Return:</dt> <dd> -the generated code (string) +the generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="MessageBoxWizard.__handle" ID="MessageBoxWizard.__handle"></a> @@ -154,7 +160,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of None and activation status (boolean) +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="MessageBoxWizard.deactivate" ID="MessageBoxWizard.deactivate"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardQRegularExpression.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardQRegularExpression.html Fri Dec 22 19:45:17 2023 +0100 @@ -98,9 +98,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="QRegularExpressionWizard.__callForm" ID="QRegularExpressionWizard.__callForm"></a> @@ -112,7 +112,7 @@ </p> <dl> -<dt><i>editor</i></dt> +<dt><i>editor</i> (Editor)</dt> <dd> reference to the current editor </dd> @@ -120,7 +120,13 @@ <dl> <dt>Return:</dt> <dd> -the generated code (string) +the generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="QRegularExpressionWizard.__handle" ID="QRegularExpressionWizard.__handle"></a> @@ -154,7 +160,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of None and activation status (boolean) +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="QRegularExpressionWizard.deactivate" ID="QRegularExpressionWizard.deactivate"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.ViewManagerPlugins.Tabview.Tabview.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.ViewManagerPlugins.Tabview.Tabview.html Fri Dec 22 19:45:17 2023 +0100 @@ -437,9 +437,9 @@ </p> <dl> -<dt><i>index</i></dt> +<dt><i>index</i> (int)</dt> <dd> -index of the tab (integer) +index of the tab </dd> </dl> <a NAME="TabWidget.__contextMenuClose" ID="TabWidget.__contextMenuClose"></a> @@ -862,9 +862,9 @@ </p> <dl> -<dt><i>event</i></dt> +<dt><i>event</i> (QMouseEvent)</dt> <dd> -reference to the event object (QMouseEvent) +reference to the event object </dd> </dl> <a NAME="TabWidget.removeWidget" ID="TabWidget.removeWidget"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.ColorDialogWizard.ColorDialogWizardDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.ColorDialogWizard.ColorDialogWizardDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -98,9 +98,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="ColorDialogWizardDialog.getCode" ID="ColorDialogWizardDialog.getCode"></a> @@ -112,19 +112,25 @@ </p> <dl> -<dt><i>indLevel</i></dt> +<dt><i>indLevel</i> (int)</dt> <dd> -indentation level (int) +indentation level </dd> -<dt><i>indString</i></dt> +<dt><i>indString</i> (str)</dt> <dd> -string used for indentation (space or tab) (string) +string used for indentation (space or tab) </dd> </dl> <dl> <dt>Return:</dt> <dd> -generated code (string) +generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="ColorDialogWizardDialog.on_bTest_clicked" ID="ColorDialogWizardDialog.on_bTest_clicked"></a> @@ -143,9 +149,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="ColorDialogWizardDialog.on_eColor_editTextChanged" ID="ColorDialogWizardDialog.on_eColor_editTextChanged"></a> @@ -157,9 +163,9 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -the new text (string) +the new text </dd> </dl> <a NAME="ColorDialogWizardDialog.on_eRGB_textChanged" ID="ColorDialogWizardDialog.on_eRGB_textChanged"></a> @@ -171,9 +177,9 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -the new text (string) +the new text </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.DotDesktopWizard.DotDesktopListSelectionDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.DotDesktopWizard.DotDesktopListSelectionDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -78,36 +78,36 @@ </p> <dl> -<dt><i>entries</i></dt> +<dt><i>entries</i> (list of str)</dt> <dd> -list of entries to be shown (list of string) +list of entries to be shown </dd> -<dt><i>selectedEntries</i></dt> +<dt><i>selectedEntries</i> (list of str or str)</dt> <dd> -list of entries to be selected (list of string - or string of entries separated by separator) +list of entries to be selected or a string with + entries separated by separator </dd> -<dt><i>separator</i></dt> +<dt><i>separator</i> (str)</dt> <dd> -separator string (string) +separator string </dd> -<dt><i>subEntries</i></dt> +<dt><i>subEntries</i> (list of str)</dt> <dd> -secondary list of entries (list of string) +secondary list of entries </dd> -<dt><i>allowMultiMain</i></dt> +<dt><i>allowMultiMain</i> (bool)</dt> <dd> flag indicating to allow multiple selections for - the main entry (bool) + the main entry </dd> -<dt><i>allowMultiSub</i></dt> +<dt><i>allowMultiSub</i> (bool)</dt> <dd> flag indicating to allow multiple selections for - the sub entry (bool) + the sub entry </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="DotDesktopListSelectionDialog.getData" ID="DotDesktopListSelectionDialog.getData"></a> @@ -120,20 +120,26 @@ </p> <dl> -<dt><i>separator</i></dt> +<dt><i>separator</i> (str)</dt> <dd> -separator string (string) +separator string </dd> -<dt><i>separatorAtEnd</i></dt> +<dt><i>separatorAtEnd</i> (bool)</dt> <dd> -flag indicating to append the separator (boolean) +flag indicating to append the separator </dd> </dl> <dl> <dt>Return:</dt> <dd> -list of selected entries (list of string) if the separator is - None or a string with entries delimited by separator (string) +list of selected entries if the separator is None or a string + with entries delimited by separator +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list od str or str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.DotDesktopWizard.DotDesktopWizardDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.DotDesktopWizard.DotDesktopWizardDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -118,9 +118,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="DotDesktopWizardDialog.__checkOK" ID="DotDesktopWizardDialog.__checkOK"></a> @@ -140,7 +140,13 @@ <dl> <dt>Return:</dt> <dd> -generated code (string) +generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="DotDesktopWizardDialog.on_categoriesButton_clicked" ID="DotDesktopWizardDialog.on_categoriesButton_clicked"></a> @@ -159,9 +165,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the entry field (string) +text of the entry field </dd> </dl> <a NAME="DotDesktopWizardDialog.on_notShowButton_clicked" ID="DotDesktopWizardDialog.on_notShowButton_clicked"></a> @@ -180,9 +186,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the entry field (string) +text of the entry field </dd> </dl> <a NAME="DotDesktopWizardDialog.on_onlyShowButton_clicked" ID="DotDesktopWizardDialog.on_onlyShowButton_clicked"></a> @@ -201,9 +207,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the entry field (string) +text of the entry field </dd> </dl> <a NAME="DotDesktopWizardDialog.on_projectButton_clicked" ID="DotDesktopWizardDialog.on_projectButton_clicked"></a> @@ -223,9 +229,9 @@ </p> <dl> -<dt><i>index</i></dt> +<dt><i>index</i> (int)</dt> <dd> -index of the selected entry (integer) +index of the selected entry </dd> </dl> <a NAME="DotDesktopWizardDialog.on_typeEdit_textChanged" ID="DotDesktopWizardDialog.on_typeEdit_textChanged"></a> @@ -237,9 +243,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text of the entry field (string) +text of the entry field </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.EricPluginWizard.PluginWizardDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.EricPluginWizard.PluginWizardDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -94,9 +94,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="PluginWizardDialog.__enableOkButton" ID="PluginWizardDialog.__enableOkButton"></a> @@ -116,7 +116,13 @@ <dl> <dt>Return:</dt> <dd> -generated code (string) +generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="PluginWizardDialog.on_pluginTypeCombo_currentTextChanged" ID="PluginWizardDialog.on_pluginTypeCombo_currentTextChanged"></a> @@ -128,9 +134,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -selected plug-in type (string) +selected plug-in type </dd> </dl> <a NAME="PluginWizardDialog.on_projectButton_clicked" ID="PluginWizardDialog.on_projectButton_clicked"></a> @@ -151,7 +157,13 @@ <dl> <dt>Return:</dt> <dd> -plug-in package name (string) +plug-in package name +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.FileDialogWizard.FileDialogWizardDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.FileDialogWizard.FileDialogWizardDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -164,9 +164,9 @@ </p> <dl> -<dt><i>checkedId</i></dt> +<dt><i>checkedId</i> (int)</dt> <dd> -id of the clicked button (integer) +id of the clicked button </dd> </dl> <a NAME="FileDialogWizardDialog.getCode" ID="FileDialogWizardDialog.getCode"></a> @@ -178,19 +178,25 @@ </p> <dl> -<dt><i>indLevel</i></dt> +<dt><i>indLevel</i> (int)</dt> <dd> -indentation level (int) +indentation level </dd> -<dt><i>indString</i></dt> +<dt><i>indString</i> (str)</dt> <dd> -string used for indentation (space or tab) (string) +string used for indentation (space or tab) </dd> </dl> <dl> <dt>Return:</dt> <dd> -generated code (string) +generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="FileDialogWizardDialog.on_bTest_clicked" ID="FileDialogWizardDialog.on_bTest_clicked"></a> @@ -209,9 +215,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="FileDialogWizardDialog.on_pyqtComboBox_currentIndexChanged" ID="FileDialogWizardDialog.on_pyqtComboBox_currentIndexChanged"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.FontDialogWizard.FontDialogWizardDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.FontDialogWizard.FontDialogWizardDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -102,9 +102,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="FontDialogWizardDialog.getCode" ID="FontDialogWizardDialog.getCode"></a> @@ -116,19 +116,25 @@ </p> <dl> -<dt><i>indLevel</i></dt> +<dt><i>indLevel</i> (int)</dt> <dd> -indentation level (int) +indentation level </dd> -<dt><i>indString</i></dt> +<dt><i>indString</i> (str)</dt> <dd> -string used for indentation (space or tab) (string) +string used for indentation (space or tab) </dd> </dl> <dl> <dt>Return:</dt> <dd> -generated code (string) +generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="FontDialogWizardDialog.on_bTest_clicked" ID="FontDialogWizardDialog.on_bTest_clicked"></a> @@ -147,9 +153,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="FontDialogWizardDialog.on_eVariable_textChanged" ID="FontDialogWizardDialog.on_eVariable_textChanged"></a> @@ -161,9 +167,9 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -the new text (string) +the new text </dd> </dl> <a NAME="FontDialogWizardDialog.on_fontButton_clicked" ID="FontDialogWizardDialog.on_fontButton_clicked"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.InputDialogWizard.InputDialogWizardDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.InputDialogWizard.InputDialogWizardDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -94,9 +94,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="InputDialogWizardDialog.__typeSelectButtonToggled" ID="InputDialogWizardDialog.__typeSelectButtonToggled"></a> @@ -126,19 +126,25 @@ </p> <dl> -<dt><i>indLevel</i></dt> +<dt><i>indLevel</i> (int)</dt> <dd> -indentation level (int) +indentation level </dd> -<dt><i>indString</i></dt> +<dt><i>indString</i> (str)</dt> <dd> -string used for indentation (space or tab) (string) +string used for indentation (space or tab) </dd> </dl> <dl> <dt>Return:</dt> <dd> -generated code (string) +generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="InputDialogWizardDialog.on_bTest_clicked" ID="InputDialogWizardDialog.on_bTest_clicked"></a> @@ -157,9 +163,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.MessageBoxWizard.MessageBoxWizardDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.MessageBoxWizard.MessageBoxWizardDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -110,9 +110,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="MessageBoxWizardDialog.__enabledGroups" ID="MessageBoxWizardDialog.__enabledGroups"></a> @@ -131,19 +131,25 @@ </p> <dl> -<dt><i>istring</i></dt> +<dt><i>istring</i> (str)</dt> <dd> -indentation string (string) +indentation string </dd> -<dt><i>indString</i></dt> +<dt><i>indString</i> (str)</dt> <dd> -string used for indentation (space or tab) (string) +string used for indentation (space or tab) </dd> </dl> <dl> <dt>Return:</dt> <dd> -the button code (string) +the button code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="MessageBoxWizardDialog.__testSelectedOptions" ID="MessageBoxWizardDialog.__testSelectedOptions"></a> @@ -162,19 +168,25 @@ </p> <dl> -<dt><i>indLevel</i></dt> +<dt><i>indLevel</i> (int)</dt> <dd> -indentation level (int) +indentation level </dd> -<dt><i>indString</i></dt> +<dt><i>indString</i> (str)</dt> <dd> -string used for indentation (space or tab) (string) +string used for indentation (space or tab) </dd> </dl> <dl> <dt>Return:</dt> <dd> -generated code (string) +generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="MessageBoxWizardDialog.on_bTest_clicked" ID="MessageBoxWizardDialog.on_bTest_clicked"></a> @@ -193,9 +205,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="MessageBoxWizardDialog.on_rAboutQt_toggled" ID="MessageBoxWizardDialog.on_rAboutQt_toggled"></a>
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.PyRegExpWizard.PyRegExpWizardCharactersDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.PyRegExpWizard.PyRegExpWizardCharactersDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -102,9 +102,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="PyRegExpWizardCharactersDialog.__addRangesLine" ID="PyRegExpWizardCharactersDialog.__addRangesLine"></a> @@ -130,19 +130,25 @@ </p> <dl> -<dt><i>index</i></dt> +<dt><i>index</i> (int)</dt> <dd> -selected list index (integer) +selected list index </dd> -<dt><i>char</i></dt> +<dt><i>char</i> (str)</dt> <dd> -character string enetered into the dialog (string) +character string enetered into the dialog </dd> </dl> <dl> <dt>Return:</dt> <dd> -formated character string (string) +formated character string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="PyRegExpWizardCharactersDialog.__performSelectedAction" ID="PyRegExpWizardCharactersDialog.__performSelectedAction"></a> @@ -154,13 +160,13 @@ </p> <dl> -<dt><i>index</i></dt> +<dt><i>index</i> (int)</dt> <dd> -selected list index (integer) +selected list index </dd> -<dt><i>lineedit</i></dt> +<dt><i>lineedit</i> (QLineEdit)</dt> <dd> -line edit widget to act on (QLineEdit) +line edit widget to act on </dd> </dl> <a NAME="PyRegExpWizardCharactersDialog.__rangesCharTypeSelected" ID="PyRegExpWizardCharactersDialog.__rangesCharTypeSelected"></a> @@ -211,7 +217,13 @@ <dl> <dt>Return:</dt> <dd> -formatted string for character classes (string) +formatted string for character classes +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.PyRegExpWizard.PyRegExpWizardDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.PyRegExpWizard.PyRegExpWizardDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -86,11 +86,11 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> -<dt><i>fromEric</i></dt> +<dt><i>fromEric</i> (bool)</dt> <dd> flag indicating a call from within eric </dd> @@ -104,19 +104,25 @@ </p> <dl> -<dt><i>indLevel</i></dt> +<dt><i>indLevel</i> (int)</dt> <dd> -indentation level (int) +indentation level </dd> -<dt><i>indString</i></dt> +<dt><i>indString</i> (str)</dt> <dd> -string used for indentation (space or tab) (string) +string used for indentation (space or tab) </dd> </dl> <dl> <dt>Return:</dt> <dd> -generated code (string) +generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -280,11 +286,11 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> -<dt><i>fromEric</i></dt> +<dt><i>fromEric</i> (bool)</dt> <dd> flag indicating a call from within eric </dd> @@ -298,15 +304,14 @@ </p> <dl> -<dt><i>s</i></dt> +<dt><i>s</i> (str)</dt> <dd> string to be inserted into the regexp line edit - (string) </dd> -<dt><i>steps</i></dt> +<dt><i>steps</i> (int)</dt> <dd> -number of characters to move the cursor (integer). - Negative steps moves cursor back, positives forward. +number of characters to move the cursor. Negative steps + move cursor back, positive steps forward. </dd> </dl> <a NAME="PyRegExpWizardWidget.getCode" ID="PyRegExpWizardWidget.getCode"></a> @@ -318,19 +323,25 @@ </p> <dl> -<dt><i>indLevel</i></dt> +<dt><i>indLevel</i> (int)</dt> <dd> -indentation level (int) +indentation level </dd> -<dt><i>indString</i></dt> +<dt><i>indString</i> (str)</dt> <dd> -string used for indentation (space or tab) (string) +string used for indentation (space or tab) </dd> </dl> <dl> <dt>Return:</dt> <dd> -generated code (string) +generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="PyRegExpWizardWidget.on_altnButton_clicked" ID="PyRegExpWizardWidget.on_altnButton_clicked"></a> @@ -363,9 +374,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="PyRegExpWizardWidget.on_charButton_clicked" ID="PyRegExpWizardWidget.on_charButton_clicked"></a> @@ -412,7 +423,7 @@ </p> <dl> -<dt><i>startpos</i></dt> +<dt><i>startpos</i> (int)</dt> <dd> starting position for the regexp matching </dd> @@ -588,9 +599,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.PyRegExpWizard.PyRegExpWizardRepeatDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.PyRegExpWizard.PyRegExpWizardRepeatDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -86,9 +86,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="PyRegExpWizardRepeatDialog.getRepeat" ID="PyRegExpWizardRepeatDialog.getRepeat"></a> @@ -101,7 +101,13 @@ <dl> <dt>Return:</dt> <dd> -ready formatted repeat string (string) +ready formatted repeat string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="PyRegExpWizardRepeatDialog.on_lowerSpin_valueChanged" ID="PyRegExpWizardRepeatDialog.on_lowerSpin_valueChanged"></a> @@ -113,9 +119,9 @@ </p> <dl> -<dt><i>value</i></dt> +<dt><i>value</i> (int)</dt> <dd> -value of the spinbox (integer) +value of the spinbox </dd> </dl> <a NAME="PyRegExpWizardRepeatDialog.on_upperSpin_valueChanged" ID="PyRegExpWizardRepeatDialog.on_upperSpin_valueChanged"></a> @@ -127,9 +133,9 @@ </p> <dl> -<dt><i>value</i></dt> +<dt><i>value</i> (int)</dt> <dd> -value of the spinbox (integer) +value of the spinbox </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardCharactersDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardCharactersDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -114,9 +114,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="QRegularExpressionWizardCharactersDialog.__addRangesLine" ID="QRegularExpressionWizardCharactersDialog.__addRangesLine"></a> @@ -142,20 +142,26 @@ </p> <dl> -<dt><i>char</i></dt> +<dt><i>char</i> (str)</dt> <dd> -character string entered into the dialog (string) +character string entered into the dialog </dd> -<dt><i>formatIdentifier</i></dt> +<dt><i>formatIdentifier</i> (str)</dt> <dd> string giving a special format (-c, -h, -i or - -o) or the already formatted character (string) + -o) or the already formatted character </dd> </dl> <dl> <dt>Return:</dt> <dd> -formatted character string (string) +formatted character string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="QRegularExpressionWizardCharactersDialog.__initCharacterSelectors" ID="QRegularExpressionWizardCharactersDialog.__initCharacterSelectors"></a> @@ -174,17 +180,17 @@ </p> <dl> -<dt><i>formatIdentifier</i></dt> +<dt><i>formatIdentifier</i> (str)</dt> <dd> -format of the selected entry (string) +format of the selected entry </dd> -<dt><i>lineedit</i></dt> +<dt><i>lineedit</i> (QLineEdit)</dt> <dd> -line edit widget to act on (QLineEdit) +line edit widget to act on </dd> -<dt><i>combo</i></dt> +<dt><i>combo</i> (QComboBox)</dt> <dd> -combo box widget to act on (QComboBox) +combo box widget to act on </dd> </dl> <a NAME="QRegularExpressionWizardCharactersDialog.__populateCharTypeCombo" ID="QRegularExpressionWizardCharactersDialog.__populateCharTypeCombo"></a> @@ -196,13 +202,13 @@ </p> <dl> -<dt><i>combo</i></dt> +<dt><i>combo</i> (QComboBox)</dt> <dd> -reference to the combo box to be populated (QComboBox) +reference to the combo box to be populated </dd> -<dt><i>isSingle</i></dt> +<dt><i>isSingle</i> (bool)</dt> <dd> -flag indicating a singles combo (boolean) +flag indicating a singles combo </dd> </dl> <a NAME="QRegularExpressionWizardCharactersDialog.__populateCharacterCombo" ID="QRegularExpressionWizardCharactersDialog.__populateCharacterCombo"></a> @@ -214,11 +220,11 @@ </p> <dl> -<dt><i>combo</i></dt> +<dt><i>combo</i> (QComboBox)</dt> <dd> -combo box to be populated (QComboBox) +combo box to be populated </dd> -<dt><i>formatIdentifier</i></dt> +<dt><i>formatIdentifier</i> (str)</dt> <dd> format identifier (one of "-ccp", "-ccn", "-cbp", "-cbn", "-csp", "-csn", "-psp", "-psn") @@ -272,7 +278,13 @@ <dl> <dt>Return:</dt> <dd> -formatted string for character classes (string) +formatted string for character classes +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -94,11 +94,11 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> -<dt><i>fromEric</i></dt> +<dt><i>fromEric</i> (bool)</dt> <dd> flag indicating a call from within eric </dd> @@ -119,19 +119,25 @@ </p> <dl> -<dt><i>indLevel</i></dt> +<dt><i>indLevel</i> (int)</dt> <dd> -indentation level (int) +indentation level </dd> -<dt><i>indString</i></dt> +<dt><i>indString</i> (str)</dt> <dd> -string used for indentation (space or tab) (string) +string used for indentation (space or tab) </dd> </dl> <dl> <dt>Return:</dt> <dd> -generated code (string) +generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="QRegularExpressionWizardDialog.reject" ID="QRegularExpressionWizardDialog.reject"></a> @@ -318,11 +324,11 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> -<dt><i>fromEric</i></dt> +<dt><i>fromEric</i> (bool)</dt> <dd> flag indicating a call from within eric </dd> @@ -336,15 +342,14 @@ </p> <dl> -<dt><i>s</i></dt> +<dt><i>s</i> (str)</dt> <dd> string to be inserted into the regexp line edit - (string) </dd> -<dt><i>steps</i></dt> +<dt><i>steps</i> (int)</dt> <dd> -number of characters to move the cursor (integer). - Negative steps moves cursor back, positives forward. +number of characters to move the cursor. Negative steps + move cursor back, positive steps forward. </dd> </dl> <a NAME="QRegularExpressionWizardWidget.__receiveResponse" ID="QRegularExpressionWizardWidget.__receiveResponse"></a> @@ -357,7 +362,13 @@ <dl> <dt>Return:</dt> <dd> -response dictionary (dict) +response dictionary +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict </dd> </dl> <a NAME="QRegularExpressionWizardWidget.__sendCommand" ID="QRegularExpressionWizardWidget.__sendCommand"></a> @@ -369,12 +380,11 @@ </p> <dl> -<dt><i>command</i></dt> +<dt><i>command</i> (dict)</dt> <dd> -dictionary with command string and related - data (dict) +dictionary with command string and related data </dd> -<dt><i>kw=</i></dt> +<dt><i>kw=</i> (dict)</dt> <dd> parameters for the command </dd> @@ -382,7 +392,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating a successful transmission (boolean) +flag indicating a successful transmission +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="QRegularExpressionWizardWidget.getCode" ID="QRegularExpressionWizardWidget.getCode"></a> @@ -394,19 +410,25 @@ </p> <dl> -<dt><i>indLevel</i></dt> +<dt><i>indLevel</i> (int)</dt> <dd> -indentation level (int) +indentation level </dd> -<dt><i>indString</i></dt> +<dt><i>indString</i> (str)</dt> <dd> -string used for indentation (space or tab) (string) +string used for indentation (space or tab) </dd> </dl> <dl> <dt>Return:</dt> <dd> -generated code (string) +generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="QRegularExpressionWizardWidget.on_altnButton_clicked" ID="QRegularExpressionWizardWidget.on_altnButton_clicked"></a> @@ -446,9 +468,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="QRegularExpressionWizardWidget.on_charButton_clicked" ID="QRegularExpressionWizardWidget.on_charButton_clicked"></a> @@ -496,7 +518,7 @@ </p> <dl> -<dt><i>startpos</i></dt> +<dt><i>startpos</i> (int)</dt> <dd> starting position for the QRegularExpression matching </dd> @@ -683,9 +705,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="QRegularExpressionWizardWindow.closeEvent" ID="QRegularExpressionWizardWindow.closeEvent"></a> @@ -697,9 +719,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardRepeatDialog.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardRepeatDialog.html Fri Dec 22 19:45:17 2023 +0100 @@ -86,9 +86,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl> <a NAME="QRegularExpressionWizardRepeatDialog.getRepeat" ID="QRegularExpressionWizardRepeatDialog.getRepeat"></a> @@ -101,7 +101,13 @@ <dl> <dt>Return:</dt> <dd> -ready formatted repeat string (string) +ready formatted repeat string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="QRegularExpressionWizardRepeatDialog.on_lowerSpin_valueChanged" ID="QRegularExpressionWizardRepeatDialog.on_lowerSpin_valueChanged"></a> @@ -113,9 +119,9 @@ </p> <dl> -<dt><i>value</i></dt> +<dt><i>value</i> (int)</dt> <dd> -value of the spinbox (integer) +value of the spinbox </dd> </dl> <a NAME="QRegularExpressionWizardRepeatDialog.on_upperSpin_valueChanged" ID="QRegularExpressionWizardRepeatDialog.on_upperSpin_valueChanged"></a> @@ -127,9 +133,9 @@ </p> <dl> -<dt><i>value</i></dt> +<dt><i>value</i> (int)</dt> <dd> -value of the spinbox (integer) +value of the spinbox </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardServer.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardServer.html Fri Dec 22 19:45:17 2023 +0100 @@ -59,30 +59,35 @@ </p> <dl> -<dt><i>regexp</i></dt> +<dt><i>regexp</i> (str)</dt> <dd> -regular expression to validate (string) +regular expression to validate </dd> -<dt><i>options</i></dt> +<dt><i>options</i> (list of str)</dt> <dd> -list of options (list of string) +list of options </dd> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -text to execute on (string) +text to execute on </dd> -<dt><i>startpos</i></dt> +<dt><i>startpos</i> (int)</dt> <dd> -start position for the execution (integer) +start position for the execution </dd> </dl> <dl> <dt>Return:</dt> <dd> -tuple of a flag indicating a successful match (boolean) and - a list of captures containing the complete match as matched string - (string), match start (integer), match end (integer) and match length - (integer) for each entry +tuple of a flag indicating a successful match and a list of captures + containing the complete match as matched string, match start, match end + and match length for each entry +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, list of [str, int, int, int]) </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -97,20 +102,25 @@ </p> <dl> -<dt><i>regexp</i></dt> +<dt><i>regexp</i> (str)</dt> <dd> -regular expression to validate (string) +regular expression to validate </dd> -<dt><i>options</i></dt> +<dt><i>options</i> (list of str)</dt> <dd> -list of options (list of string) +list of options </dd> </dl> <dl> <dt>Return:</dt> <dd> -tuple of flag indicating validity (boolean), error - string (string) and error offset (integer) +tuple of flag indicating validity, error string and error offset +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str, int) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/CodeStyleChecker.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/CodeStyleChecker.py Fri Dec 22 19:45:17 2023 +0100 @@ -38,7 +38,8 @@ """ Initialize the service and return the entry point. - @return the entry point for the background client (function) + @return the entry point for the background client + @rtype function """ return codeStyleCheck @@ -47,7 +48,8 @@ """ Initialize the batch service and return the entry point. - @return the entry point for the background client (function) + @return the entry point for the background client + @rtype function """ return codeStyleBatchCheck @@ -61,7 +63,8 @@ """ Constructor - @param options options for the report (optparse.Values) + @param options options for the report + @type optparse.Values """ super().__init__(options) @@ -72,12 +75,18 @@ """ Public method to collect the error messages. - @param line_number line number of the issue (integer) - @param offset position within line of the issue (integer) - @param errorCode error message code (string) - @param check reference to the checker function (function) - @param args arguments for the message (list) - @return error code (string) + @param line_number line number of the issue + @type int + @param offset position within line of the issue + @type int + @param errorCode error message code + @type str + @param check reference to the checker function + @type function + @param args arguments for the message + @type list + @return error code + @rtype str """ errorCode = super().error_args(line_number, offset, errorCode, check, *args) if errorCode and (self.counters[errorCode] == 1 or self.__repeat): @@ -98,11 +107,16 @@ Function to extract flags starting and ending with '__' from a line comment. - @param line line to extract flags from (string) - @param startComment string identifying the start of the comment (string) - @param endComment string identifying the end of a comment (string) - @param flagsLine flag indicating to check for a flags only line (bool) - @return list containing the extracted flags (list of strings) + @param line line to extract flags from + @type str + @param startComment string identifying the start of the comment + @type str + @param endComment string identifying the end of a comment + @type str + @param flagsLine flag indicating to check for a flags only line + @type bool + @return list containing the extracted flags + @rtype list of str """ flags = [] @@ -293,8 +307,10 @@ """ Module function acting as the parallel worker for the style check. - @param inputQueue input queue (multiprocessing.Queue) - @param outputQueue output queue (multiprocessing.Queue) + @param inputQueue input queue + @type multiprocessing.Queue + @param outputQueue output queue + @type multiprocessing.Queue """ for filename, source, args in iter(inputQueue.get, "STOP"): result = __checkCodeStyle(filename, source, args)
--- a/src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/CodeStyleFixer.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/CodeStyleFixer.py Fri Dec 22 19:45:17 2023 +0100 @@ -268,8 +268,10 @@ """ Public method to save the modified file. - @param encoding encoding of the source file (string) - @return error message on failure (tuple of str) + @param encoding encoding of the source file + @type str + @return error message on failure + @rtype tuple of (str, [str]) """ if not self.__modified: # no need to write @@ -305,8 +307,10 @@ """ Private method to check, if the code should be fixed. - @param code to check (string) - @return flag indicating it should be fixed (boolean) + @param code to check + @type str + @return flag indicating it should be fixed + @rtype bool """ def mutualStartswith(a, b): @@ -315,7 +319,7 @@ against each other. @return flag indicating that one string starts with the other - (boolean) + @rtype bool """ return b.startswith(a) or a.startswith(b) @@ -367,6 +371,7 @@ Public method to apply all deferred fixes. @return dictionary containing the fix results + @rtype dict """ results = {} @@ -392,7 +397,8 @@ """ Private method to get the ID for a deferred fix. - @return ID for a deferred fix (integer) + @return ID for a deferred fix + @rtype int """ self.__lastID += 1 return self.__lastID @@ -404,6 +410,7 @@ @return tuple containing two lists of integer with start and end tuples of lines + @rtype tuple of ([int, int], [int, int]) """ logical_start = [] logical_end = [] @@ -438,12 +445,15 @@ Private method to get the logical line corresponding to the given position. - @param line line number of the issue (integer) - @param pos position inside line (integer) + @param line line number of the issue + @type int + @param pos position inside line + @type int @return tuple of a tuple of two integers giving the start of the logical line, another tuple of two integers giving the end of the logical line and a list of strings with the original source lines + @rtype tuple of ((int, int), (int, int), [str]) """ try: (logical_start, logical_end) = self.__findLogical() @@ -469,7 +479,8 @@ """ Private method to determine the indentation type. - @return string to be used for an indentation (string) + @return string to be used for an indentation + @rtype str """ sio = StringIO("".join(self.__source)) indentWord = " " # default in case of failure @@ -484,8 +495,10 @@ """ Private method to get the indentation string. - @param line line to determine the indentation string from (string) - @return indentation string (string) + @param line line to determine the indentation string from + @type str + @return indentation string + @rtype str """ return line.replace(line.lstrip(), "") @@ -496,7 +509,8 @@ @return tuple of a set of line numbers belonging to a multi line string and a set of line numbers belonging to a multi line - documentation string (tuple of two set of integer) + documentation string + @rtype tuple of (set of int, set of int) """ if self.__multiLineNumbers is None: source = "".join(self.__source) @@ -526,10 +540,14 @@ This is done by adding or removing from its initial indent only. - @param line line number of the issue (integer) - @param pos position inside line (integer) + @param line line number of the issue + @type int + @param pos position inside line + @type int @param logical logical line structure - @return flag indicating a change was done (boolean) + @type str + @return flag indicating a change was done + @rtype bool @exception ValueError raised to indicate a bad 'logical' parameter """ if not logical: @@ -570,10 +588,14 @@ """ Private method to correct whitespace at the given offset. - @param line line to be corrected (string) - @param offset offset within line (integer) - @param replacement replacement string (string) + @param line line to be corrected + @type str + @param offset offset within line + @type int + @param replacement replacement string + @type str @return corrected line + @rtype str """ left = line[:offset].rstrip(" \t") right = line[offset:].lstrip(" \t") @@ -2103,7 +2125,7 @@ Constructor @param sourceLines list of source lines including eol marker - (list of string) + @type list of str """ # Raw file lines. self.raw = sourceLines @@ -2126,7 +2148,8 @@ """ Public method to run the re-indenter. - @return flag indicating that a change was done (boolean) + @return flag indicating that a change was done + @rtype bool """ try: stats = self.__genStats(tokenize.generate_tokens(self.getline)) @@ -2204,8 +2227,10 @@ """ Public method to get a fixed line. - @param line number of the line to retrieve (integer) - @return fixed line (string) + @param line number of the line to retrieve + @type int + @return fixed line + @rtype str """ if line < len(self.after): return self.after[line] @@ -2216,7 +2241,8 @@ """ Public method to get a line of text for tokenize. - @return line of text (string) + @return line of text + @rtype str """ if self.index >= len(self.lines): line = "" @@ -2230,7 +2256,9 @@ Private method to generate the re-indent statistics. @param tokens tokens generator (tokenize._tokenize) + @type function @return reference to the generated statistics + @rtype dict """ find_stmt = True # next token begins a fresh stmt? level = 0 # current indent level @@ -2278,8 +2306,10 @@ """ Private method to count number of leading blanks. - @param line line to check (string) - @return number of leading blanks (integer) + @param line line to check + @type str + @return number of leading blanks + @rtype int """ i = 0 n = len(line) @@ -2311,7 +2341,7 @@ Constructor @param physical_lines list of physical lines to operate on - (list of strings) + @type list of str """ self.lines = physical_lines self.tokens = [] @@ -2330,7 +2360,9 @@ Private method to build a logical line from a list of tokens. @param tokens list of tokens as generated by tokenize.generate_tokens - @return logical line (string) + @type list of Token + @return logical line + @rtype str """ # from pycodestyle.py with minor modifications logical = [] @@ -2362,8 +2394,9 @@ to indent things to. @return list of lists, where each list represents valid indent levels - for the line in question, relative from the initial indent. However, - the first entry is the indent level which was expected. + for the line in question, relative from the initial indent. However, + the first entry is the indent level which was expected. + @rtype list of list """ # What follows is an adjusted version of # pycodestyle.py:continuation_line_indentation. All of the comments @@ -2539,14 +2572,21 @@ """ Constructor - @param curLine text to work on (string) - @param prevLine line before the text to work on (string) - @param nextLine line after the text to work on (string) - @param maxLength maximum allowed line length (integer) - @param eol eond-of-line marker (string) - @param indentWord string used for indentation (string) + @param curLine text to work on + @type str + @param prevLine line before the text to work on + @type str + @param nextLine line after the text to work on + @type str + @param maxLength maximum allowed line length + @type int + @param eol eond-of-line marker + @type str + @param indentWord string used for indentation + @type str @param isDocString flag indicating that the line belongs to - a documentation string (boolean) + a documentation string + @type bool """ self.__text = curLine self.__prevText = prevLine @@ -2561,7 +2601,8 @@ Public method to shorten the line wrapped by the class instance. @return tuple of a flag indicating successful shortening, the - shortened line and the changed next line (boolean, string, string) + shortened line and the changed next line + @rtype tuple of (bool, str, str) """ # 1. check for comment if self.__text.lstrip().startswith("#"): @@ -2722,8 +2763,9 @@ Private method to shorten a comment line. @param isLast flag indicating, that the line is the last comment line - (boolean) - @return shortened comment line (string) + @type bool + @return shortened comment line + @rtype str """ if len(self.__text) <= self.__maxLength: return self.__text @@ -2759,7 +2801,7 @@ Private method to break multi line strings. @return tuple of the shortened line and the changed next line - (string, string) + @rtype tuple of (str, str) """ indentation = self.__getIndent(self.__text) @@ -2821,10 +2863,13 @@ Private method to check, if the given string might be inside a string or comment. - @param line line to check (string) - @param index position inside line to check (integer) + @param line line to check + @type str + @param index position inside line to check + @type int @return flag indicating the possibility of being inside a string or comment + @rtype bool """ # Check against being in a string. for quote in ['"', "'"]: @@ -2844,10 +2889,13 @@ Private method to shorten a line of code at an operator. @param tokens tokens of the line as generated by tokenize - (list of token) - @param source code string to work at (string) - @param indent indentation string of the code line (string) - @return list of candidates (list of string) + @type list of Token + @param source code string to work at + @type str + @param indent indentation string of the code line + @type str + @return list of candidates + @rtype list of str """ candidates = [] @@ -2911,8 +2959,10 @@ Private method to remove multiline-related code that will cause syntax error. - @param text code line to work on (string) - @return normalized code line (string) + @param text code line to work on + @type str + @return normalized code line + @rtype str """ for quote in "'\"": dictPattern = r"^{q}[^{q}]*{q} *: *".format(q=quote) @@ -2933,8 +2983,10 @@ """ Private method to rank a candidate. - @param candidate candidate line to rank (string) - @return rank of the candidate (integer) + @param candidate candidate line to rank + @type str + @return rank of the candidate + @rtype int """ rank = 0 if candidate.strip(): @@ -2996,8 +3048,10 @@ Private method to determine the number of unmatched open/close brackets. - @param line line to work at (string) - @return number of unmatched open/close brackets (integer) + @param line line to work at + @type str + @return number of unmatched open/close brackets + @rtype int """ count = 0 for opening, closing in ["()", "[]", "{}"]: @@ -3010,8 +3064,10 @@ """ Private method to get the indentation string. - @param line line to determine the indentation string from (string) - @return indentation string (string) + @param line line to determine the indentation string from + @type str + @return indentation string + @rtype str """ # copied from CodeStyleFixer return line.replace(line.lstrip(), "") @@ -3020,8 +3076,10 @@ """ Private method to check the syntax of the given code fragment. - @param code code fragment to check (string) - @return flag indicating syntax is ok (boolean) + @param code code fragment to check + @type str + @return flag indicating syntax is ok + @rtype bool """ code = code.replace("\r\n", "\n").replace("\r", "\n") try:
--- a/src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/Miscellaneous/MiscellaneousChecker.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/Miscellaneous/MiscellaneousChecker.py Fri Dec 22 19:45:17 2023 +0100 @@ -1240,6 +1240,7 @@ Private function to test, if the node should be checked. @param node reference to the AST node + @type ast.Dict @return flag indicating to check the node @rtype bool """ @@ -1439,6 +1440,7 @@ @param second second token @type tuple @return flag indicating an implicit string concatenation + @rtype bool """ return first.type == second.type == tokenize.STRING @@ -1454,6 +1456,7 @@ @param second second token @type tuple @return flag indicating an implicit string concatenation + @rtype bool """ return ( (first.type == second.type == tokenize.STRING)
--- a/src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/Naming/NamingStyleChecker.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/CheckerPlugins/CodeStyleChecker/Naming/NamingStyleChecker.py Fri Dec 22 19:45:17 2023 +0100 @@ -50,8 +50,11 @@ Constructor (according to 'extended' pycodestyle.py API) @param tree AST tree of the source file - @param filename name of the source file (string) + @type ast.AST + @param filename name of the source file + @type str @param options options as parsed by pycodestyle.StyleGuide + @type optparse.Option """ self.__parents = collections.deque() self.__tree = tree @@ -110,6 +113,7 @@ @return tuple giving line number, offset within line, code and checker function + @rtype tuple of (int, int, str, function) """ if self.__tree and self.__checkers: return self.__visitTree(self.__tree) @@ -121,6 +125,7 @@ Private method to scan the given AST tree. @param node AST tree node to scan + @type ast.AST @yield tuple giving line number, offset within line and error code @ytype tuple of (int, int, str) """ @@ -135,6 +140,7 @@ Private method to inspect the given AST node. @param node AST tree node to inspect + @type ast.AST @yield tuple giving line number, offset within line and error code @ytype tuple of (int, int, str) """ @@ -155,6 +161,7 @@ static methods. @param classNode AST tree node to tag + @type ast.ClassDef """ # try to find all 'old style decorators' # like m = staticmethod(m) @@ -198,6 +205,7 @@ Private method amend a node with global definitions information. @param functionNode AST tree node to amend + @type ast.FunctionDef or ast.AsyncFunctionDef """ globalNames = set() nodesToCheck = collections.deque(ast.iter_child_nodes(functionNode)) @@ -217,7 +225,9 @@ Private method to get the argument names of a function node. @param node AST node to extract arguments names from - @return list of argument names (list of string) + @type ast.FunctionDef or ast.AsyncFunctionDef + @return list of argument names + @rtype list of str """ posArgs = [arg.arg for arg in node.args.args] kwOnly = [arg.arg for arg in node.args.kwonlyargs] @@ -228,9 +238,11 @@ Private method to build the error information. @param node AST node to report an error for - @param code error code to report (string) + @type ast.AST + @param code error code to report + @type str @return tuple giving line number, offset within line and error code - (integer, integer, string) + @rtype tuple of (int, int, str) """ if isinstance(node, ast.Module): lineno = 0 @@ -250,8 +262,10 @@ """ Private method to check, if the given name should be avoided. - @param name name to be checked (string) - @return flag indicating to avoid it (boolen) + @param name name to be checked + @type str + @return flag indicating to avoid it + @rtype bool """ return name in ("l", "O", "I") @@ -260,7 +274,9 @@ Private class to check the given node for a name to be avoided (N831). @param node AST note to check + @type ast.Ast @param parents list of parent nodes + @type list of ast.AST @yield tuple giving line number, offset within line and error code @ytype tuple of (int, int, str) """ @@ -300,7 +316,7 @@ @param name name of the class @type str @param parents list of parent nodes - @type ast.AST + @type list of ast.AST @return node containing the class definition @rtype ast.ClassDef """ @@ -318,7 +334,7 @@ @param name name of the class @type str @param parents list of parent nodes - @type ast.AST + @type list of ast.AST @param names set of collected class names (defaults to None) @type set of str (optional) @return set of class names @@ -347,7 +363,9 @@ Classes for internal use have a leading underscore in addition. @param node AST note to check + @type ast.ClassDef @param parents list of parent nodes + @type list of ast.AST @yield tuple giving line number, offset within line and error code @ytype tuple of (int, int, str) """ @@ -372,7 +390,9 @@ (e.g. threading.py), to retain backwards compatibility. @param node AST note to check + @type ast.FunctionDef or ast.AsynFunctionDef @param parents list of parent nodes + @type list of ast.AST @yield tuple giving line number, offset within line and error code @ytype tuple of (int, int, str) """ @@ -397,7 +417,9 @@ first argument. A method should have 'self' as the first argument. @param node AST note to check + @type ast.FunctionDef or ast.AsynFunctionDef @param parents list of parent nodes + @type list of ast.AST @yield tuple giving line number, offset within line and error code @ytype tuple of (int, int, str) """ @@ -440,7 +462,9 @@ Local variables in functions should be lowercase. @param node AST note to check + @type ast.AST @param parents list of parent nodes + @type list of ast.AST @yield tuple giving line number, offset within line and error code @ytype tuple of (int, int, str) """ @@ -601,8 +625,10 @@ Module and package names should be lowercase. - @param node AST note to check + @param node AST node to check + @type ast.AST @param parents list of parent nodes + @type list of ast.AST @yield tuple giving line number, offset within line and error code @ytype tuple of (int, int, str) """ @@ -622,8 +648,10 @@ Private method to check that imports don't change the naming convention (N811, N812, N813, N814, N815). - @param node AST note to check + @param node AST node to check + @type ast.Import @param parents list of parent nodes + @type list of ast.AST @yield tuple giving line number, offset within line and error code @ytype tuple of (int, int, str) """
--- a/src/eric7/Plugins/CheckerPlugins/SyntaxChecker/pyflakes/messages.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/CheckerPlugins/SyntaxChecker/pyflakes/messages.py Fri Dec 22 19:45:17 2023 +0100 @@ -28,6 +28,7 @@ @param filename name of the file @type str @param loc location of the issue + @type tuple of (int, int) """ self.filename = filename self.lineno = loc.lineno @@ -73,9 +74,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue - @param name name of the unused import (string) + @type tuple of (int, int) + @param name name of the unused import + @type str """ Message.__init__(self, filename, loc) self.message_args = (name,) @@ -93,10 +97,14 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue - @param name name of the redefined object (string) + @type tuple of (int, int) + @param name name of the redefined object + @type str @param orig_loc location of the original definition + @type tuple of (int, int) """ Message.__init__(self, filename, loc) self.message_args = (name, orig_loc.lineno) @@ -114,10 +122,14 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue - @param name name of the shadowed import (string) + @type tuple of (int, int) + @param name name of the shadowed import + @type str @param orig_loc location of the import + @type tuple of (int, int) """ Message.__init__(self, filename, loc) self.message_args = (name, orig_loc.lineno) @@ -135,9 +147,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue - @param modname name of the module (string) + @type tuple of (int, int) + @param modname name of the module + @type str """ Message.__init__(self, filename, loc) self.message_args = (modname,) @@ -155,9 +170,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue - @param modname name of the module imported using star import (string) + @type tuple of (int, int) + @param modname name of the module imported using star import + @type str """ Message.__init__(self, filename, loc) self.message_args = (modname,) @@ -175,10 +193,14 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue - @param name name of the variable (string) - @param from_list list of modules imported from with * (string) + @type tuple of (int, int) + @param name name of the variable + @type str + @param from_list list of modules imported from with * + @type str """ Message.__init__(self, filename, loc) self.message_args = (name, from_list) @@ -196,9 +218,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue - @param name undefined name (string) + @type tuple of (int, int) + @param name undefined name + @type str """ Message.__init__(self, filename, loc) self.message_args = (name,) @@ -216,9 +241,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue + @type tuple of (int, int) @param position position of the syntax error + @type tuple of (int, int) """ Message.__init__(self, filename, loc) if position: @@ -238,9 +266,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue - @param name undefined exported name (string) + @type tuple of (int, int) + @param name undefined exported name + @type str """ Message.__init__(self, filename, loc) self.message_args = (name,) @@ -261,10 +292,14 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue - @param name name of the prematurely referenced variable (string) + @type tuple of (int, int) + @param name name of the prematurely referenced variable + @type str @param orig_loc location of the variable definition + @type tuple of (int, int) """ Message.__init__(self, filename, loc) if orig_loc is None: @@ -289,9 +324,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue - @param name name of the duplicate argument (string) + @type tuple of (int, int) + @param name name of the duplicate argument + @type str """ Message.__init__(self, filename, loc) self.message_args = (name,) @@ -309,9 +347,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue - @param key dictionary key (string) + @type tuple of (int, int) + @param key dictionary key + @type str """ Message.__init__(self, filename, loc) self.message_args = (key,) @@ -329,9 +370,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue - @param key dictionary key variable (string) + @type tuple of (int, int) + @param key dictionary key variable + @type str """ Message.__init__(self, filename, loc) self.message_args = (key,) @@ -358,9 +402,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue - @param name name of the imported undefined future feature (string) + @type tuple of (int, int) + @param name name of the imported undefined future feature + @type str """ Message.__init__(self, filename, loc) self.message_args = (name,) @@ -381,9 +428,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue - @param names names of unused variable (string) + @type tuple of (int, int) + @param names names of unused variable + @type str """ Message.__init__(self, filename, loc) self.message_args = (names,) @@ -404,9 +454,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue - @param names names of unused variable (string) + @type tuple of (int, int) + @param names names of unused variable + @type str """ Message.__init__(self, filename, loc) self.message_args = (names,) @@ -525,9 +578,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue - @param annotation erroneous forward annotation (string) + @type tuple of (int, int) + @param annotation erroneous forward annotation + @type str """ Message.__init__(self, filename, loc) self.message_args = (annotation,) @@ -591,9 +647,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue + @type tuple of (int, int) @param extra_positions indexes of unused arguments + @type list of int """ Message.__init__(self, filename, loc) self.message_args = (extra_positions,) @@ -613,9 +672,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue + @type tuple of (int, int) @param extra_keywords index of unused named arguments + @type list of str """ Message.__init__(self, filename, loc) self.message_args = (extra_keywords,) @@ -635,9 +697,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue + @type tuple of (int, int) @param missing_arguments missing arguments + @type list of str """ Message.__init__(self, filename, loc) self.message_args = (missing_arguments,) @@ -668,9 +733,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue + @type tuple of (int, int) @param error error details + @type str """ Message.__init__(self, filename, loc) if not isinstance(error, str): @@ -692,9 +760,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue + @type tuple of (int, int) @param error error details + @type str """ Message.__init__(self, filename, loc) self.message_args = (error,) @@ -726,9 +797,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue + @type tuple of (int, int) @param c unsupported format character + @type str """ Message.__init__(self, filename, loc) self.message_args = (c,) @@ -749,10 +823,14 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue - @param n_placeholders number of placeholders (integer) - @param n_substitutions number of substitutions (integer) + @type tuple of (int, int) + @param n_placeholders number of placeholders + @type int + @param n_substitutions number of substitutions + @type int """ Message.__init__(self, filename, loc) self.message_args = (n_placeholders, n_substitutions) @@ -772,9 +850,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue + @type tuple of (int, int) @param extra_keywords index of unused named arguments + @type list of str """ Message.__init__(self, filename, loc) self.message_args = (extra_keywords,) @@ -794,9 +875,12 @@ """ Constructor - @param filename name of the file (string) + @param filename name of the file + @type str @param loc location of the issue + @type tuple of (int, int) @param missing_arguments missing arguments + @type list of str """ Message.__init__(self, filename, loc) self.message_args = (missing_arguments,)
--- a/src/eric7/Plugins/CheckerPlugins/SyntaxChecker/pyflakes/translations.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/CheckerPlugins/SyntaxChecker/pyflakes/translations.py Fri Dec 22 19:45:17 2023 +0100 @@ -147,9 +147,12 @@ Module function to get a translated and formatted message for a given pyflakes message ID. - @param message_id message ID (string) - @param message_args arguments for a formatted message (list) - @return translated and formatted message (string) + @param message_id message ID + @type str + @param message_args arguments for a formatted message + @type list + @return translated and formatted message + @rtype str """ if message_id in _messages: msg = _messages[message_id].replace("{0!r}", "'{0}'")
--- a/src/eric7/Plugins/DocumentationPlugins/Ericapi/EricapiConfigDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/DocumentationPlugins/Ericapi/EricapiConfigDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -30,9 +30,12 @@ """ Constructor - @param project reference to the project object (Project.Project) + @param project reference to the project object + @type Project @param parms parameters to set in the dialog + @type dict @param parent parent widget of this dialog + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -223,7 +226,8 @@ """ Private slot to enable/disable the "OK" button. - @param filename name of the file (string) + @param filename name of the file + @type str """ self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled( filename != ""
--- a/src/eric7/Plugins/DocumentationPlugins/Ericapi/EricapiExecDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/DocumentationPlugins/Ericapi/EricapiExecDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -34,8 +34,10 @@ """ Constructor - @param cmdname name of the ericapi generator (string) - @param parent parent widget of this dialog (QWidget) + @param cmdname name of the ericapi generator + @type str + @param parent parent widget of this dialog + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -51,10 +53,12 @@ """ Public slot to start the ericapi command. - @param args commandline arguments for ericapi program (list of strings) + @param args commandline arguments for ericapi program + @type list of str @param fn filename or dirname to be processed by ericapi program - (string) - @return flag indicating the successful start of the process (boolean) + @type str + @return flag indicating the successful start of the process + @rtype bool """ self.errorGroup.hide() @@ -101,7 +105,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.accept()
--- a/src/eric7/Plugins/DocumentationPlugins/Ericdoc/EricdocConfigDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/DocumentationPlugins/Ericdoc/EricdocConfigDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -34,9 +34,12 @@ """ Constructor - @param project reference to the project object (Project.Project) + @param project reference to the project object + @type Project @param parms parameters to set in the dialog + @type dict @param parent parent widget of this dialog + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -406,7 +409,8 @@ """ Private method to select a color. - @param colorKey key of the color to select (string) + @param colorKey key of the color to select + @type str """ color = QColorDialog.getColor(QColor(self.colors[colorKey])) if color.isValid(): @@ -500,7 +504,8 @@ """ Private slot to toggle the generation of QtHelp files. - @param enabled flag indicating the state (boolean) + @param enabled flag indicating the state + @type bool """ self.__checkQtHelpOptions() @@ -509,7 +514,8 @@ """ Private slot to check the namespace. - @param txt text of the line edit (string) + @param txt text of the line edit + @type str """ self.__checkQtHelpOptions() @@ -518,7 +524,8 @@ """ Private slot to check the virtual folder. - @param txt text of the line edit (string) + @param txt text of the line edit + @type str """ self.__checkQtHelpOptions() @@ -527,7 +534,8 @@ """ Private slot to check the title. - @param txt text of the line edit (string) + @param txt text of the line edit + @type str """ self.__checkQtHelpOptions()
--- a/src/eric7/Plugins/DocumentationPlugins/Ericdoc/EricdocExecDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/DocumentationPlugins/Ericdoc/EricdocExecDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -34,8 +34,10 @@ """ Constructor - @param cmdname name of the documentation generator (string) - @param parent parent widget of this dialog (QWidget) + @param cmdname name of the documentation generator + @type str + @param parent parent widget of this dialog + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -51,10 +53,12 @@ """ Public slot to start the ericdoc command. - @param args commandline arguments for ericdoc program (list of strings) + @param args commandline arguments for ericdoc program + @type list of str @param fn filename or dirname to be processed by ericdoc program - (string) - @return flag indicating the successful start of the process (boolean) + @type str + @return flag indicating the successful start of the process + @rtype bool """ self.errorGroup.hide() @@ -101,7 +105,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close): self.accept()
--- a/src/eric7/Plugins/PluginAbout.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginAbout.py Fri Dec 22 19:45:17 2023 +0100 @@ -42,7 +42,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ super().__init__(ui) self.__ui = ui @@ -53,7 +54,8 @@ """ Public method to activate this plugin. - @return tuple of None and activation status (boolean) + @return tuple of None and activation status + @rtype bool """ self.__initActions() self.__initMenu()
--- a/src/eric7/Plugins/PluginCodeStyleChecker.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginCodeStyleChecker.py Fri Dec 22 19:45:17 2023 +0100 @@ -64,7 +64,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ super().__init__(ui) self.__ui = ui @@ -94,8 +95,10 @@ """ Private slot handling service errors. - @param fn file name (string) - @param msg message text (string) + @param fn file name + @type str + @param msg message text + @type str """ self.error.emit(fn, msg) @@ -103,10 +106,14 @@ """ Public slot handling service errors for Python 3. - @param fx service name (string) - @param lang language (string) - @param fn file name (string) - @param msg message text (string) + @param fx service name + @type str + @param lang language + @type str + @param fn file name + @type str + @param msg message text + @type str """ if fx in ["style", "batch_style"] and lang == "Python3": if fx == "style": @@ -119,8 +126,10 @@ """ Public slot handling the completion of a batch job. - @param fx service name (string) - @param lang language (string) + @param fx service name + @type str + @param lang language + @type str """ if fx in ["style", "batch_style"]: if lang in self.queuedBatches: @@ -244,7 +253,8 @@ """ Public method to activate this plugin. - @return tuple of None and activation status (boolean) + @return tuple of None and activation status + @rtype bool """ menu = ericApp().getObject("Project").getMenu("Checks") if menu: @@ -327,8 +337,10 @@ Private slot called, when the the project menu or a submenu is about to be shown. - @param menuName name of the menu to be shown (string) - @param menu reference to the menu (QMenu) + @param menuName name of the menu to be shown + @type str + @param menu reference to the menu + @type QMenu """ if menuName == "Checks" and self.__projectAct is not None: self.__projectAct.setEnabled( @@ -341,8 +353,10 @@ Private slot called, when the the project browser menu or a submenu is about to be shown. - @param menuName name of the menu to be shown (string) - @param menu reference to the menu (QMenu) + @param menuName name of the menu to be shown + @type str + @param menu reference to the menu + @type QMenu """ if menuName == "Checks" and ericApp().getObject( "Project" @@ -428,7 +442,8 @@ """ Private slot called, when a new editor was opened. - @param editor reference to the new editor (QScintilla.Editor) + @param editor reference to the new editor + @type Editor """ menu = editor.getMenu("Checks") if menu is not None: @@ -440,7 +455,8 @@ """ Private slot called, when an editor was closed. - @param editor reference to the editor (QScintilla.Editor) + @param editor reference to the editor + @type Editor """ with contextlib.suppress(ValueError): self.__editors.remove(editor) @@ -450,9 +466,12 @@ Private slot called, when the the editor context menu or a submenu is about to be shown. - @param menuName name of the menu to be shown (string) - @param menu reference to the menu (QMenu) + @param menuName name of the menu to be shown + @type str + @param menu reference to the menu + @type QMenu @param editor reference to the editor + @type Editor """ if menuName == "Checks": if self.__editorAct not in menu.actions():
--- a/src/eric7/Plugins/PluginEricapi.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginEricapi.py Fri Dec 22 19:45:17 2023 +0100 @@ -46,6 +46,7 @@ @return dictionary containing the data to query the presence of the executable + @rtype dict """ exe = "eric7_api" if OSUtilities.isWindowsPlatform(): @@ -97,7 +98,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ super().__init__(ui) self.__ui = ui @@ -114,7 +116,8 @@ """ Public method to activate this plugin. - @return tuple of None and activation status (boolean) + @return tuple of None and activation status + @rtype bool """ menu = ericApp().getObject("Project").getMenu("Apidoc") if menu: @@ -160,8 +163,10 @@ Private slot called, when the the project menu or a submenu is about to be shown. - @param menuName name of the menu to be shown (string) - @param menu reference to the menu (QMenu) + @param menuName name of the menu to be shown + @type str + @param menu reference to the menu + @type QMenu """ if menuName == "Apidoc" and self.__projectAct is not None: self.__projectAct.setEnabled(
--- a/src/eric7/Plugins/PluginEricdoc.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginEricdoc.py Fri Dec 22 19:45:17 2023 +0100 @@ -52,6 +52,7 @@ @return dictionary containing the data to query the presence of the executable + @rtype dict """ dataList = [] @@ -141,7 +142,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ super().__init__(ui) self.__ui = ui @@ -158,7 +160,8 @@ """ Public method to activate this plugin. - @return tuple of None and activation status (boolean) + @return tuple of None and activation status + @rtype bool """ menu = ericApp().getObject("Project").getMenu("Apidoc") if menu: @@ -204,8 +207,10 @@ Private slot called, when the the project menu or a submenu is about to be shown. - @param menuName name of the menu to be shown (string) - @param menu reference to the menu (QMenu) + @param menuName name of the menu to be shown + @type str + @param menu reference to the menu + @type QMenu """ if menuName == "Apidoc" and self.__projectAct is not None: self.__projectAct.setEnabled(
--- a/src/eric7/Plugins/PluginVcsGit.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginVcsGit.py Fri Dec 22 19:45:17 2023 +0100 @@ -45,6 +45,7 @@ @return dictionary containing the data to query the presence of the executable + @rtype dict """ exe = "git" if OSUtilities.isWindowsPlatform(): @@ -69,7 +70,8 @@ Public function to get the indicators for this version control system. @return dictionary with indicator as key and a tuple with the vcs name - (string) and vcs display string (string) + and vcs display string + @rtype dict """ ##global __header__ data = {} @@ -86,7 +88,8 @@ """ Public function to get the display string. - @return display string (string) + @return display string + @rtype str """ exe = "git" if OSUtilities.isWindowsPlatform(): @@ -104,8 +107,10 @@ """ Module function to create the configuration page. - @param configDlg reference to the configuration dialog (QDialog) + @param configDlg reference to the configuration dialog + @type QDialog @return reference to the configuration page + @rtype GitPage """ from eric7.Plugins.VcsPlugins.vcsGit.ConfigurationPage.GitPage import GitPage @@ -121,8 +126,8 @@ """ Module function returning data as required by the configuration dialog. - @return dictionary with key "zzz_gitPage" containing the relevant - data + @return dictionary with key "zzz_gitPage" containing the relevant data + @rtype dict """ return { "zzz_gitPage": [ @@ -184,7 +189,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ from eric7.Plugins.VcsPlugins.vcsGit.ProjectHelper import GitProjectHelper @@ -206,6 +212,7 @@ Public method to get a reference to the project helper object. @return reference to the project helper object + @rtype GitProjectHelper """ return self.__projectHelperObject @@ -213,9 +220,10 @@ """ Public slot to initialize the VCS toolbar. - @param ui reference to the main window (UserInterface) + @param ui reference to the main window + @type UserInterface @param toolbarManager reference to a toolbar manager object - (EricToolBarManager) + @type EricToolBarManager """ if self.__projectHelperObject: self.__projectHelperObject.initToolbar(ui, toolbarManager) @@ -224,8 +232,9 @@ """ Public method to activate this plugin. - @return tuple of reference to instantiated viewmanager and - activation status (boolean) + @return tuple of reference to instantiated version control and + activation status + @rtype tuple of (Git, bool) """ from eric7.Plugins.VcsPlugins.vcsGit.git import Git @@ -261,7 +270,9 @@ Class method to retrieve the various settings. @param key the key of the value to get + @type str @return the requested setting + @rtype Any """ if key in [ "StopLogOnCopy", @@ -304,7 +315,9 @@ Class method to store the various settings. @param key the key of the setting to be set + @type str @param value the value to be set + @type Any """ Preferences.getSettings().setValue("Git/" + key, value) @@ -312,7 +325,8 @@ """ Public method to get the filename of the config file. - @return filename of the config file (string) + @return filename of the config file + @rtype str """ return getConfigPath()
--- a/src/eric7/Plugins/PluginVcsMercurial.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginVcsMercurial.py Fri Dec 22 19:45:17 2023 +0100 @@ -50,6 +50,7 @@ @return dictionary containing the data to query the presence of the executable + @rtype dict """ data = { "programEntry": True, @@ -72,9 +73,9 @@ Public function to get the indicators for this version control system. @return dictionary with indicator as key and a tuple with the vcs name - (string) and vcs display string (string) + and vcs display string + @rtype dict """ - ##global __header__ data = {} exe = getHgExecutable() if FileSystemUtilities.isinpath(exe): @@ -87,7 +88,8 @@ """ Public function to get the display string. - @return display string (string) + @return display string + @rtype str """ exe = getHgExecutable() if FileSystemUtilities.isinpath(exe): @@ -103,8 +105,10 @@ """ Module function to create the configuration page. - @param configDlg reference to the configuration dialog (QDialog) + @param configDlg reference to the configuration dialog + @type QDialog @return reference to the configuration page + @rtype MercurialPage """ from eric7.Plugins.VcsPlugins.vcsMercurial.ConfigurationPage.MercurialPage import ( MercurialPage, @@ -122,8 +126,8 @@ """ Module function returning data as required by the configuration dialog. - @return dictionary with key "zzz_mercurialPage" containing the relevant - data + @return dictionary with key "zzz_mercurialPage" containing the relevant data + @rtype dict """ return { "zzz_mercurialPage": [ @@ -192,7 +196,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ from eric7.Plugins.VcsPlugins.vcsMercurial.ProjectHelper import HgProjectHelper @@ -213,6 +218,7 @@ Public method to get a reference to the project helper object. @return reference to the project helper object + @rtype HgProjectHelper """ return self.__projectHelperObject @@ -220,9 +226,10 @@ """ Public slot to initialize the VCS toolbar. - @param ui reference to the main window (UserInterface) + @param ui reference to the main window + @type UserInterface @param toolbarManager reference to a toolbar manager object - (EricToolBarManager) + @type EricToolBarManager """ if self.__projectHelperObject: self.__projectHelperObject.initToolbar(ui, toolbarManager) @@ -232,7 +239,8 @@ Public method to activate this plugin. @return tuple of reference to instantiated viewmanager and - activation status (boolean) + activation status + @rtype tuple of (Hg, bool) """ from eric7.Plugins.VcsPlugins.vcsMercurial.hg import Hg @@ -268,7 +276,9 @@ Class method to retrieve the various settings. @param key the key of the value to get + @type str @return the requested setting + @rtype Any """ if key in ( "StopLogOnCopy", @@ -332,7 +342,9 @@ Class method to store the various settings. @param key the key of the setting to be set + @type str @param value the value to be set + @type Any """ Preferences.getSettings().setValue("Mercurial/" + key, value) @@ -340,7 +352,8 @@ """ Public method to build a list of global options. - @return list of global options (list of string) + @return list of global options + @rtype list of str """ args = [] if self.getPreferences("Encoding") != self.MercurialDefaults["Encoding"]: @@ -360,7 +373,8 @@ """ Public method to get the filename of the config file. - @return filename of the config file (string) + @return filename of the config file + @rtype str """ return getConfigPath()
--- a/src/eric7/Plugins/PluginVcsPySvn.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginVcsPySvn.py Fri Dec 22 19:45:17 2023 +0100 @@ -44,6 +44,7 @@ Public method to support the display of some executable info. @return dictionary containing the data to be shown + @rtype dict """ try: import pysvn # __IGNORE_WARNING_I10__ @@ -74,7 +75,8 @@ Public function to get the indicators for this version control system. @return dictionary with indicator as key and a tuple with the vcs name - (string) and vcs display string (string) + and vcs display string + @rtype dict """ return { ".svn": (__header__["pluginTypename"], displayString()), @@ -86,7 +88,8 @@ """ Public function to get the display string. - @return display string (string) + @return display string + @rtype str """ if importlib.util.find_spec("pysvn") is None: return "" @@ -101,8 +104,10 @@ """ Module function to create the configuration page. - @param configDlg reference to the configuration dialog (QDialog) + @param configDlg reference to the configuration dialog + @type QDialog @return reference to the configuration page + @rtype SubversionPage """ from eric7.Plugins.VcsPlugins.vcsPySvn.ConfigurationPage.SubversionPage import ( SubversionPage, @@ -122,6 +127,7 @@ @return dictionary with key "zzz_subversionPage" containing the relevant data + @rtype dict """ return { "zzz_subversionPage": [ @@ -153,7 +159,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ from eric7.Plugins.VcsPlugins.vcsPySvn.ProjectHelper import PySvnProjectHelper @@ -179,6 +186,7 @@ Public method to get a reference to the project helper object. @return reference to the project helper object + @rtype PySvnProjectHelper """ return self.__projectHelperObject @@ -186,9 +194,10 @@ """ Public slot to initialize the VCS toolbar. - @param ui reference to the main window (UserInterface) + @param ui reference to the main window + @type UserInterface @param toolbarManager reference to a toolbar manager object - (EricToolBarManager) + @type EricToolBarManager """ if self.__projectHelperObject: self.__projectHelperObject.initToolbar(ui, toolbarManager) @@ -198,7 +207,8 @@ Public method to activate this plugin. @return tuple of reference to instantiated viewmanager and - activation status (boolean) + activation status + @rtype tuple of (Subversion, bool) """ from eric7.Plugins.VcsPlugins.vcsPySvn.subversion import Subversion @@ -233,7 +243,9 @@ Public method to retrieve the various settings. @param key the key of the value to get + @type str @return the requested refactoring setting + @rtype Any """ if key in ["StopLogOnCopy"]: return Preferences.toBool( @@ -259,7 +271,9 @@ Public method to store the various settings. @param key the key of the setting to be set + @type str @param value the value to be set + @type Any """ Preferences.getSettings().setValue("Subversion/" + key, value) @@ -267,7 +281,8 @@ """ Public method to get the filename of the servers file. - @return filename of the servers file (string) + @return filename of the servers file + @rtype str """ return getServersPath() @@ -275,7 +290,8 @@ """ Public method to get the filename of the config file. - @return filename of the config file (string) + @return filename of the config file + @rtype str """ return getConfigPath()
--- a/src/eric7/Plugins/PluginVcsSubversion.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginVcsSubversion.py Fri Dec 22 19:45:17 2023 +0100 @@ -50,6 +50,7 @@ @return dictionary containing the data to query the presence of the executable + @rtype dict """ exe = "svn" if OSUtilities.isWindowsPlatform(): @@ -76,9 +77,9 @@ Public function to get the indicators for this version control system. @return dictionary with indicator as key and a tuple with the vcs name - (string) and vcs display string (string) + and vcs display string + @rtype dict """ - ##global pluginTypename data = {} exe = "svn" if OSUtilities.isWindowsPlatform(): @@ -93,7 +94,8 @@ """ Public function to get the display string. - @return display string (string) + @return display string + @rtype str """ exe = "svn" if OSUtilities.isWindowsPlatform(): @@ -111,8 +113,10 @@ """ Module function to create the configuration page. - @param configDlg reference to the configuration dialog (QDialog) + @param configDlg reference to the configuration dialog + @type QDialog @return reference to the configuration page + @rtype SubversionPage """ from eric7.Plugins.VcsPlugins.vcsSubversion.ConfigurationPage import SubversionPage @@ -129,6 +133,7 @@ Module function returning data as required by the configuration dialog. @return dictionary with key "zzz_subversionPage" containing the relevant + @rtype dict data """ return { @@ -161,7 +166,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ from eric7.Plugins.VcsPlugins.vcsSubversion.ProjectHelper import ( SvnProjectHelper, @@ -189,6 +195,7 @@ Public method to get a reference to the project helper object. @return reference to the project helper object + @rtype SvnProjectHelper """ return self.__projectHelperObject @@ -196,9 +203,10 @@ """ Public slot to initialize the VCS toolbar. - @param ui reference to the main window (UserInterface) + @param ui reference to the main window + @type UserInterface @param toolbarManager reference to a toolbar manager object - (EricToolBarManager) + @type EricToolBarManager """ if self.__projectHelperObject: self.__projectHelperObject.initToolbar(ui, toolbarManager) @@ -208,7 +216,8 @@ Public method to activate this plugin. @return tuple of reference to instantiated viewmanager and - activation status (boolean) + activation status + @rtype tuple of (Subversion, bool) """ from eric7.Plugins.VcsPlugins.vcsSubversion.subversion import Subversion @@ -243,7 +252,9 @@ Public method to retrieve the various settings. @param key the key of the value to get + @type str @return the requested setting + @rtype Any """ if key in ["StopLogOnCopy"]: return Preferences.toBool( @@ -269,7 +280,9 @@ Public method to store the various settings. @param key the key of the setting to be set + @type str @param value the value to be set + @type Any """ Preferences.getSettings().setValue("Subversion/" + key, value) @@ -277,7 +290,8 @@ """ Public method to get the filename of the servers file. - @return filename of the servers file (string) + @return filename of the servers file + @rtype str """ return getServersPath() @@ -285,7 +299,8 @@ """ Public method to get the filename of the config file. - @return filename of the config file (string) + @return filename of the config file + @rtype str """ return getConfigPath()
--- a/src/eric7/Plugins/PluginVmListspace.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginVmListspace.py Fri Dec 22 19:45:17 2023 +0100 @@ -39,7 +39,8 @@ """ Module function to return a preview pixmap. - @return preview pixmap (QPixmap) + @return preview pixmap + @rtype QPixmap """ fname = os.path.join( os.path.dirname(__file__), "ViewManagerPlugins", "Listspace", "preview.png" @@ -56,7 +57,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ super().__init__(ui) self.__ui = ui @@ -66,7 +68,8 @@ Public method to activate this plugin. @return tuple of reference to instantiated viewmanager and - activation status (boolean) + activation status + @rtype bool """ from eric7.Plugins.ViewManagerPlugins.Listspace.Listspace import Listspace
--- a/src/eric7/Plugins/PluginVmTabview.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginVmTabview.py Fri Dec 22 19:45:17 2023 +0100 @@ -39,7 +39,8 @@ """ Module function to return a preview pixmap. - @return preview pixmap (QPixmap) + @return preview pixmap + @rtype QPixmap """ fname = os.path.join( os.path.dirname(__file__), "ViewManagerPlugins", "Tabview", "preview.png" @@ -56,7 +57,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ super().__init__(ui) self.__ui = ui @@ -66,7 +68,8 @@ Public method to activate this plugin. @return tuple of reference to instantiated viewmanager and - activation status (boolean) + activation status + @rtype bool """ from eric7.Plugins.ViewManagerPlugins.Tabview.Tabview import Tabview
--- a/src/eric7/Plugins/PluginWizardDotDesktop.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginWizardDotDesktop.py Fri Dec 22 19:45:17 2023 +0100 @@ -45,7 +45,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ super().__init__(ui) self.__ui = ui @@ -61,7 +62,8 @@ """ Public method to activate this plug-in. - @return tuple of None and activation status (boolean) + @return tuple of None and activation status + @rtype bool """ self.__initAction() self.__initMenu()
--- a/src/eric7/Plugins/PluginWizardEricMessageBox.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginWizardEricMessageBox.py Fri Dec 22 19:45:17 2023 +0100 @@ -42,7 +42,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ super().__init__(ui) self.__ui = ui @@ -51,7 +52,8 @@ """ Public method to activate this plugin. - @return tuple of None and activation status (boolean) + @return tuple of None and activation status + @rtype bool """ self.__initAction() self.__initMenu() @@ -105,7 +107,9 @@ Private method to display a dialog and get the code. @param editor reference to the current editor - @return the generated code (string) + @type Editor + @return the generated code + @rtype str """ from eric7.Plugins.WizardPlugins.EricMessageBoxWizard import ( EricMessageBoxWizardDialog,
--- a/src/eric7/Plugins/PluginWizardEricPlugin.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginWizardEricPlugin.py Fri Dec 22 19:45:17 2023 +0100 @@ -48,7 +48,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ super().__init__(ui) self.__ui = ui @@ -64,7 +65,8 @@ """ Public method to activate this plug-in. - @return tuple of None and activation status (boolean) + @return tuple of None and activation status + @rtype bool """ self.__initAction() self.__initMenu() @@ -118,8 +120,8 @@ """ Private method to display a dialog and get the code. - @return generated code (string), the plug-in package name (string) - and a flag indicating success (boolean) + @return generated code, the plug-in package name and a flag indicating success + @rtype tuple of (str, str, bool) """ from eric7.Plugins.WizardPlugins.EricPluginWizard.PluginWizardDialog import ( PluginWizardDialog,
--- a/src/eric7/Plugins/PluginWizardPyRegExp.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginWizardPyRegExp.py Fri Dec 22 19:45:17 2023 +0100 @@ -42,7 +42,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ super().__init__(ui) self.__ui = ui @@ -51,7 +52,8 @@ """ Public method to activate this plugin. - @return tuple of None and activation status (boolean) + @return tuple of None and activation status + @rtype bool """ self.__initAction() self.__initMenu() @@ -105,7 +107,9 @@ Private method to display a dialog and get the code. @param editor reference to the current editor - @return the generated code (string) + @type Editor + @return the generated code + @rtype str """ from eric7.Plugins.WizardPlugins.PyRegExpWizard.PyRegExpWizardDialog import ( PyRegExpWizardDialog,
--- a/src/eric7/Plugins/PluginWizardQColorDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginWizardQColorDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -42,7 +42,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ super().__init__(ui) self.__ui = ui @@ -51,7 +52,8 @@ """ Public method to activate this plugin. - @return tuple of None and activation status (boolean) + @return tuple of None and activation status + @rtype bool """ self.__initAction() self.__initMenu() @@ -105,7 +107,9 @@ Private method to display a dialog and get the code. @param editor reference to the current editor - @return the generated code (string) and a success flag (boolean) + @type Editor + @return the generated code and a success flag + @rtype tuple of (str, bool) """ from eric7.Plugins.WizardPlugins.ColorDialogWizard import ( ColorDialogWizardDialog,
--- a/src/eric7/Plugins/PluginWizardQFileDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginWizardQFileDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -44,7 +44,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ super().__init__(ui) self.__ui = ui @@ -56,7 +57,8 @@ """ Public method to activate this plugin. - @return tuple of None and activation status (boolean) + @return tuple of None and activation status + @rtype bool """ self.__initActions() self.__initMenu() @@ -139,7 +141,8 @@ @param variant variant of code to be generated (-1 = EricFileDialog, 0 = unknown, 5 = PyQt5, 6 = PyQt6) @type int - @return the generated code (string) + @return the generated code + @rtype str """ from eric7.Plugins.WizardPlugins.FileDialogWizard import FileDialogWizardDialog
--- a/src/eric7/Plugins/PluginWizardQFontDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginWizardQFontDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -42,7 +42,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ super().__init__(ui) self.__ui = ui @@ -51,7 +52,8 @@ """ Public method to activate this plugin. - @return tuple of None and activation status (boolean) + @return tuple of None and activation status + @rtype bool """ self.__initAction() self.__initMenu() @@ -105,7 +107,9 @@ Private method to display a dialog and get the code. @param editor reference to the current editor - @return the generated code (string) + @type Editor + @return the generated code + @rtype str """ from eric7.Plugins.WizardPlugins.FontDialogWizard import FontDialogWizardDialog
--- a/src/eric7/Plugins/PluginWizardQInputDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginWizardQInputDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -42,7 +42,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ super().__init__(ui) self.__ui = ui @@ -51,7 +52,8 @@ """ Public method to activate this plugin. - @return tuple of None and activation status (boolean) + @return tuple of None and activation status + @rtype bool """ self.__initAction() self.__initMenu() @@ -105,7 +107,9 @@ Private method to display a dialog and get the code. @param editor reference to the current editor - @return the generated code (string) + @type Editor + @return the generated code + @rtype str """ from eric7.Plugins.WizardPlugins.InputDialogWizard import ( InputDialogWizardDialog,
--- a/src/eric7/Plugins/PluginWizardQMessageBox.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginWizardQMessageBox.py Fri Dec 22 19:45:17 2023 +0100 @@ -42,7 +42,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ super().__init__(ui) self.__ui = ui @@ -51,7 +52,8 @@ """ Public method to activate this plugin. - @return tuple of None and activation status (boolean) + @return tuple of None and activation status + @rtype bool """ self.__initAction() self.__initMenu() @@ -105,7 +107,9 @@ Private method to display a dialog and get the code. @param editor reference to the current editor - @return the generated code (string) + @type Editor + @return the generated code + @rtype str """ from eric7.Plugins.WizardPlugins.MessageBoxWizard import MessageBoxWizardDialog
--- a/src/eric7/Plugins/PluginWizardQRegularExpression.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/PluginWizardQRegularExpression.py Fri Dec 22 19:45:17 2023 +0100 @@ -42,7 +42,8 @@ """ Constructor - @param ui reference to the user interface object (UI.UserInterface) + @param ui reference to the user interface object + @type UserInterface """ super().__init__(ui) self.__ui = ui @@ -51,7 +52,8 @@ """ Public method to activate this plugin. - @return tuple of None and activation status (boolean) + @return tuple of None and activation status + @rtype bool """ self.__initAction() self.__initMenu() @@ -105,7 +107,9 @@ Private method to display a dialog and get the code. @param editor reference to the current editor - @return the generated code (string) + @type Editor + @return the generated code + @rtype str """ from eric7.Plugins.WizardPlugins.QRegularExpressionWizard import ( QRegularExpressionWizardDialog,
--- a/src/eric7/Plugins/ViewManagerPlugins/Tabview/Tabview.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/ViewManagerPlugins/Tabview/Tabview.py Fri Dec 22 19:45:17 2023 +0100 @@ -842,7 +842,8 @@ """ Private method to handle the press of the individual tab close button. - @param index index of the tab (integer) + @param index index of the tab + @type int """ if index >= 0: self.vm.closeEditorWindow(self.widget(index).getEditor()) @@ -851,7 +852,8 @@ """ Protected method handling double click events. - @param event reference to the event object (QMouseEvent) + @param event reference to the event object + @type QMouseEvent """ self.vm.newEditor()
--- a/src/eric7/Plugins/WizardPlugins/ColorDialogWizard/ColorDialogWizardDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/WizardPlugins/ColorDialogWizard/ColorDialogWizardDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -30,7 +30,8 @@ """ Constructor - @param parent parent widget (QWidget) + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -46,7 +47,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.bTest: self.on_bTest_clicked() @@ -98,7 +100,8 @@ """ Private slot to handle the textChanged signal of eRGB. - @param text the new text (string) + @param text the new text + @type str """ if not text: self.sRed.setEnabled(True) @@ -117,7 +120,8 @@ """ Private slot to handle the editTextChanged signal of eColor. - @param text the new text (string) + @param text the new text + @type str """ if not text or text.startswith("Qt.") or text.startswith("#"): self.bTest.setEnabled(True) @@ -128,9 +132,12 @@ """ Public method to get the source code. - @param indLevel indentation level (int) - @param indString string used for indentation (space or tab) (string) - @return generated code (string) + @param indLevel indentation level + @type int + @param indString string used for indentation (space or tab) + @type str + @return generated code + @rtype str """ # calculate our indentation level and the indentation string il = indLevel + 1
--- a/src/eric7/Plugins/WizardPlugins/DotDesktopWizard/DotDesktopListSelectionDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/WizardPlugins/DotDesktopWizard/DotDesktopListSelectionDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -30,16 +30,23 @@ """ Constructor - @param entries list of entries to be shown (list of string) - @param selectedEntries list of entries to be selected (list of string - or string of entries separated by separator) - @param separator separator string (string) - @param subEntries secondary list of entries (list of string) + @param entries list of entries to be shown + @type list of str + @param selectedEntries list of entries to be selected or a string with + entries separated by separator + @type list of str or str + @param separator separator string + @type str + @param subEntries secondary list of entries + @type list of str @param allowMultiMain flag indicating to allow multiple selections for - the main entry (bool) + the main entry + @type bool @param allowMultiSub flag indicating to allow multiple selections for - the sub entry (bool) - @param parent reference to the parent widget (QWidget) + the sub entry + @type bool + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -74,10 +81,13 @@ Public method to extract the selected entries as a list or a string. - @param separator separator string (string) - @param separatorAtEnd flag indicating to append the separator (boolean) - @return list of selected entries (list of string) if the separator is - None or a string with entries delimited by separator (string) + @param separator separator string + @type str + @param separatorAtEnd flag indicating to append the separator + @type bool + @return list of selected entries if the separator is None or a string + with entries delimited by separator + @rtype list od str or str """ entries = [] for itm in self.entriesList.selectedItems():
--- a/src/eric7/Plugins/WizardPlugins/DotDesktopWizard/DotDesktopWizardDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/WizardPlugins/DotDesktopWizard/DotDesktopWizardDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -29,7 +29,8 @@ """ Constructor - @param parent reference to the parent widget (QWidget) + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -252,7 +253,8 @@ """ Public method to get the source code. - @return generated code (string) + @return generated code + @rtype str """ # step 1: standard desktop entries code = [ @@ -351,7 +353,8 @@ """ Private slot to handle a change of the .desktop type. - @param index index of the selected entry (integer) + @param index index of the selected entry + @type int """ self.dataTabWidget.setTabEnabled(1, index == 1) self.dataTabWidget.setTabEnabled(2, index == 2) @@ -407,7 +410,8 @@ """ Private slot to check the contents of the onlyShowEdit field. - @param txt text of the entry field (string) + @param txt text of the entry field + @type str """ self.__checkOK() if bool(self.onlyShowEdit.text()) and bool(self.notShowEdit.text()): @@ -436,7 +440,8 @@ """ Private slot to check the contents of the notShowEdit field. - @param txt text of the entry field (string) + @param txt text of the entry field + @type str """ self.__checkOK() if bool(self.onlyShowEdit.text()) and bool(self.notShowEdit.text()): @@ -465,7 +470,8 @@ """ Private slot to check, if the typeEdit field is empty. - @param txt text of the entry field (string) + @param txt text of the entry field + @type str """ self.__checkOK() @@ -474,6 +480,7 @@ """ Private slot to check, if the nameEdit field is empty. - @param txt text of the entry field (string) + @param txt text of the entry field + @type str """ self.__checkOK()
--- a/src/eric7/Plugins/WizardPlugins/EricPluginWizard/PluginWizardDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/WizardPlugins/EricPluginWizard/PluginWizardDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -38,7 +38,8 @@ """ Constructor - @param parent reference to the parent widget (QWidget) + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -125,7 +126,8 @@ """ Public method to get the source code. - @return generated code (string) + @return generated code + @rtype str """ templateData = { "year": QDate.currentDate().year(), @@ -197,7 +199,8 @@ """ Public method to retrieve the plug-in package name. - @return plug-in package name (string) + @return plug-in package name + @rtype str """ if self.createPackageCheckBox.isChecked(): return self.packageNameEdit.text() @@ -209,6 +212,7 @@ """ Private slot to react upon the selection of a plug-in type. - @param txt selected plug-in type (string) + @param txt selected plug-in type + @type str """ self.pixmapCheckBox.setChecked(txt == "viewmanager")
--- a/src/eric7/Plugins/WizardPlugins/FileDialogWizard/FileDialogWizardDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/WizardPlugins/FileDialogWizard/FileDialogWizardDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -165,7 +165,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.bTest: self.on_bTest_clicked() @@ -313,7 +314,8 @@ Private slot to enable/disable the initial filter elements and the results entries. - @param checkedId id of the clicked button (integer) + @param checkedId id of the clicked button + @type int """ enable = (self.__dialogVariant in (-1, -2) and checkedId in [11, 12, 13]) or ( self.__dialogVariant in (5, 6) and checkedId in [1, 2, 3, 21, 22, 23] @@ -332,9 +334,12 @@ """ Public method to get the source code for Qt6. - @param indLevel indentation level (int) - @param indString string used for indentation (space or tab) (string) - @return generated code (string) + @param indLevel indentation level + @type int + @param indString string used for indentation (space or tab) + @type str + @return generated code + @rtype str """ # calculate our indentation level and the indentation string il = indLevel + 1
--- a/src/eric7/Plugins/WizardPlugins/FontDialogWizard/FontDialogWizardDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/WizardPlugins/FontDialogWizard/FontDialogWizardDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -39,7 +39,8 @@ """ Constructor - @param parent parent widget (QWidget) + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -64,7 +65,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.bTest: self.on_bTest_clicked() @@ -95,7 +97,8 @@ """ Private slot to handle the textChanged signal of eVariable. - @param text the new text (string) + @param text the new text + @type str """ if not text: self.bTest.setEnabled(True) @@ -132,9 +135,12 @@ """ Public method to get the source code. - @param indLevel indentation level (int) - @param indString string used for indentation (space or tab) (string) - @return generated code (string) + @param indLevel indentation level + @type int + @param indString string used for indentation (space or tab) + @type str + @return generated code + @rtype str """ # calculate our indentation level and the indentation string il = indLevel + 1
--- a/src/eric7/Plugins/WizardPlugins/InputDialogWizard/InputDialogWizardDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/WizardPlugins/InputDialogWizard/InputDialogWizardDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -28,7 +28,8 @@ """ Constructor - @param parent parent widget (QWidget) + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -89,7 +90,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.bTest: self.on_bTest_clicked() @@ -157,9 +159,12 @@ """ Public method to get the source code for Qt6. - @param indLevel indentation level (int) - @param indString string used for indentation (space or tab) (string) - @return generated code (string) + @param indLevel indentation level + @type int + @param indString string used for indentation (space or tab) + @type str + @return generated code + @rtype str """ # calculate our indentation level and the indentation string il = indLevel + 1
--- a/src/eric7/Plugins/WizardPlugins/MessageBoxWizard/MessageBoxWizardDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/WizardPlugins/MessageBoxWizard/MessageBoxWizardDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -27,7 +27,8 @@ """ Constructor - @param parent parent widget (QWidget) + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -186,7 +187,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.bTest: self.on_bTest_clicked() @@ -232,9 +234,12 @@ """ Private method to generate the button code. - @param istring indentation string (string) - @param indString string used for indentation (space or tab) (string) - @return the button code (string) + @param istring indentation string + @type str + @param indString string used for indentation (space or tab) + @type str + @return the button code + @rtype str """ buttons = [] if self.abortCheck.isChecked(): @@ -291,9 +296,12 @@ """ Public method to get the source code. - @param indLevel indentation level (int) - @param indString string used for indentation (space or tab) (string) - @return generated code (string) + @param indLevel indentation level + @type int + @param indString string used for indentation (space or tab) + @type str + @return generated code + @rtype str """ # calculate our indentation level and the indentation string il = indLevel + 1
--- a/src/eric7/Plugins/WizardPlugins/PyRegExpWizard/PyRegExpWizardCharactersDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/WizardPlugins/PyRegExpWizard/PyRegExpWizardCharactersDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -39,7 +39,8 @@ """ Constructor - @param parent parent widget (QWidget) + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -212,8 +213,10 @@ """ Private method performing some actions depending on the input. - @param index selected list index (integer) - @param lineedit line edit widget to act on (QLineEdit) + @param index selected list index + @type int + @param lineedit line edit widget to act on + @type QLineEdit """ if index < 3: lineedit.setEnabled(True) @@ -262,9 +265,12 @@ """ Private method to format the characters entered into the dialog. - @param index selected list index (integer) - @param char character string enetered into the dialog (string) - @return formated character string (string) + @param index selected list index + @type int + @param char character string enetered into the dialog + @type str + @return formated character string + @rtype str """ if index == 0: return char @@ -282,7 +288,8 @@ """ Public method to return the character string assembled via the dialog. - @return formatted string for character classes (string) + @return formatted string for character classes + @rtype str """ regexp = ""
--- a/src/eric7/Plugins/WizardPlugins/PyRegExpWizard/PyRegExpWizardDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/WizardPlugins/PyRegExpWizard/PyRegExpWizardDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -41,8 +41,10 @@ """ Constructor - @param parent parent widget (QWidget) + @param parent parent widget + @type QWidget @param fromEric flag indicating a call from within eric + @type bool """ super().__init__(parent) self.setupUi(self) @@ -119,9 +121,10 @@ Private method to insert a string into line edit and move cursor. @param s string to be inserted into the regexp line edit - (string) - @param steps number of characters to move the cursor (integer). - Negative steps moves cursor back, positives forward. + @type str + @param steps number of characters to move the cursor. Negative steps + move cursor back, positive steps forward. + @type int """ self.regexpTextEdit.insertPlainText(s) tc = self.regexpTextEdit.textCursor() @@ -304,7 +307,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.validateButton: self.on_validateButton_clicked() @@ -460,6 +464,7 @@ data and will display the result in the table part of the dialog. @param startpos starting position for the regexp matching + @type int """ regex = self.regexpTextEdit.toPlainText() text = self.textTextEdit.toPlainText() @@ -614,9 +619,12 @@ """ Public method to get the source code. - @param indLevel indentation level (int) - @param indString string used for indentation (space or tab) (string) - @return generated code (string) + @param indLevel indentation level + @type int + @param indString string used for indentation (space or tab) + @type str + @return generated code + @rtype str """ # calculate the indentation string istring = indLevel * indString @@ -665,8 +673,10 @@ """ Constructor - @param parent parent widget (QWidget) + @param parent parent widget + @type QWidget @param fromEric flag indicating a call from within eric + @type bool """ super().__init__(parent) self.setModal(fromEric) @@ -689,9 +699,12 @@ """ Public method to get the source code. - @param indLevel indentation level (int) - @param indString string used for indentation (space or tab) (string) - @return generated code (string) + @param indLevel indentation level + @type int + @param indString string used for indentation (space or tab) + @type str + @return generated code + @rtype str """ return self.cw.getCode(indLevel, indString) @@ -705,7 +718,8 @@ """ Constructor - @param parent reference to the parent widget (QWidget) + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.cw = PyRegExpWizardWidget(self, fromEric=False)
--- a/src/eric7/Plugins/WizardPlugins/PyRegExpWizard/PyRegExpWizardRepeatDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/WizardPlugins/PyRegExpWizard/PyRegExpWizardRepeatDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -22,7 +22,8 @@ """ Constructor - @param parent parent widget (QWidget) + @param parent parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -37,7 +38,8 @@ """ Private slot to handle the lowerSpin valueChanged signal. - @param value value of the spinbox (integer) + @param value value of the spinbox + @type int """ if self.upperSpin.value() < value: self.upperSpin.setValue(value) @@ -47,7 +49,8 @@ """ Private slot to handle the upperSpin valueChanged signal. - @param value value of the spinbox (integer) + @param value value of the spinbox + @type int """ if self.lowerSpin.value() > value: self.lowerSpin.setValue(value) @@ -56,7 +59,8 @@ """ Public method to retrieve the dialog's result. - @return ready formatted repeat string (string) + @return ready formatted repeat string + @rtype str """ minimal = "?" if self.minimalCheckBox.isChecked() else ""
--- a/src/eric7/Plugins/WizardPlugins/QRegularExpressionWizard/QRegularExpressionWizardCharactersDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/WizardPlugins/QRegularExpressionWizard/QRegularExpressionWizardCharactersDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -39,7 +39,8 @@ """ Constructor - @param parent reference to the parent widget (QWidget) + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -343,8 +344,10 @@ """ Private method to populate a given character type selection combo box. - @param combo reference to the combo box to be populated (QComboBox) - @param isSingle flag indicating a singles combo (boolean) + @param combo reference to the combo box to be populated + @type QComboBox + @param isSingle flag indicating a singles combo + @type bool """ for txt, value in self.comboItems: combo.addItem(txt, value) @@ -433,9 +436,11 @@ """ Private method to populate a character selection combo. - @param combo combo box to be populated (QComboBox) + @param combo combo box to be populated + @type QComboBox @param formatIdentifier format identifier (one of "-ccp", "-ccn", "-cbp", "-cbn", "-csp", "-csn", "-psp", "-psn") + @type str """ combo.clear() @@ -458,9 +463,12 @@ """ Private method performing some actions depending on the input. - @param formatIdentifier format of the selected entry (string) - @param lineedit line edit widget to act on (QLineEdit) - @param combo combo box widget to act on (QComboBox) + @param formatIdentifier format of the selected entry + @type str + @param lineedit line edit widget to act on + @type QLineEdit + @param combo combo box widget to act on + @type QComboBox """ if formatIdentifier == "-i": return @@ -537,10 +545,13 @@ """ Private method to format the characters entered into the dialog. - @param char character string entered into the dialog (string) + @param char character string entered into the dialog + @type str @param formatIdentifier string giving a special format (-c, -h, -i or - -o) or the already formatted character (string) - @return formatted character string (string) + -o) or the already formatted character + @type str + @return formatted character string + @rtype str """ if formatIdentifier == "-c": return char @@ -575,7 +586,8 @@ """ Public method to return the character string assembled via the dialog. - @return formatted string for character classes (string) + @return formatted string for character classes + @rtype str """ regexp = ""
--- a/src/eric7/Plugins/WizardPlugins/QRegularExpressionWizard/QRegularExpressionWizardDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/WizardPlugins/QRegularExpressionWizard/QRegularExpressionWizardDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -42,8 +42,10 @@ """ Constructor - @param parent parent widget (QWidget) + @param parent parent widget + @type QWidget @param fromEric flag indicating a call from within eric + @type bool """ super().__init__(parent) self.setupUi(self) @@ -142,10 +144,12 @@ """ Private method to send a command to the server. - @param command dictionary with command string and related - data (dict) + @param command dictionary with command string and related data + @type dict @keyparam kw parameters for the command - @return flag indicating a successful transmission (boolean) + @type dict + @return flag indicating a successful transmission + @rtype bool """ result = False if command: @@ -161,7 +165,8 @@ """ Private method to receive a response from the server. - @return response dictionary (dict) + @return response dictionary + @rtype dict """ responseDict = {} if self.__pyqt6Server.waitForReadyRead(10000): @@ -192,9 +197,10 @@ Private method to insert a string into line edit and move cursor. @param s string to be inserted into the regexp line edit - (string) - @param steps number of characters to move the cursor (integer). - Negative steps moves cursor back, positives forward. + @type str + @param steps number of characters to move the cursor. Negative steps + move cursor back, positive steps forward. + @type int """ self.regexpTextEdit.insertPlainText(s) tc = self.regexpTextEdit.textCursor() @@ -388,7 +394,8 @@ """ Private slot called by a button of the button box clicked. - @param button button that was clicked (QAbstractButton) + @param button button that was clicked + @type QAbstractButton """ if button == self.validateButton: self.on_validateButton_clicked() @@ -569,6 +576,7 @@ test data and will display the result in the table part of the dialog. @param startpos starting position for the QRegularExpression matching + @type int """ if not self.__pyqt6Available: # only available for PyQt6 @@ -756,9 +764,12 @@ """ Public method to get the source code. - @param indLevel indentation level (int) - @param indString string used for indentation (space or tab) (string) - @return generated code (string) + @param indLevel indentation level + @type int + @param indString string used for indentation (space or tab) + @type str + @return generated code + @rtype str """ # calculate the indentation string i1string = (indLevel + 1) * indString @@ -815,8 +826,10 @@ """ Constructor - @param parent parent widget (QWidget) + @param parent parent widget + @type QWidget @param fromEric flag indicating a call from within eric + @type bool """ super().__init__(parent) self.setModal(fromEric) @@ -839,9 +852,12 @@ """ Public method to get the source code. - @param indLevel indentation level (int) - @param indString string used for indentation (space or tab) (string) - @return generated code (string) + @param indLevel indentation level + @type int + @param indString string used for indentation (space or tab) + @type str + @return generated code + @rtype str """ return self.cw.getCode(indLevel, indString) @@ -869,7 +885,8 @@ """ Constructor - @param parent reference to the parent widget (QWidget) + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.cw = QRegularExpressionWizardWidget(self, fromEric=False) @@ -887,7 +904,8 @@ """ Protected method handling the close event. - @param evt close event (QCloseEvent) + @param evt close event + @type QCloseEvent """ self.cw.shutdown() super().closeEvent(evt)
--- a/src/eric7/Plugins/WizardPlugins/QRegularExpressionWizard/QRegularExpressionWizardRepeatDialog.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/WizardPlugins/QRegularExpressionWizard/QRegularExpressionWizardRepeatDialog.py Fri Dec 22 19:45:17 2023 +0100 @@ -26,7 +26,8 @@ """ Constructor - @param parent reference to the parent widget (QWidget) + @param parent reference to the parent widget + @type QWidget """ super().__init__(parent) self.setupUi(self) @@ -42,7 +43,8 @@ """ Private slot to handle the lowerSpin valueChanged signal. - @param value value of the spinbox (integer) + @param value value of the spinbox + @type int """ if self.upperSpin.value() < value: self.upperSpin.setValue(value) @@ -52,7 +54,8 @@ """ Private slot to handle the upperSpin valueChanged signal. - @param value value of the spinbox (integer) + @param value value of the spinbox + @type int """ if self.lowerSpin.value() > value: self.lowerSpin.setValue(value) @@ -61,7 +64,8 @@ """ Public method to retrieve the dialog's result. - @return ready formatted repeat string (string) + @return ready formatted repeat string + @rtype str """ if self.possessiveButton.isChecked(): greedy = "+"
--- a/src/eric7/Plugins/WizardPlugins/QRegularExpressionWizard/QRegularExpressionWizardServer.py Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Plugins/WizardPlugins/QRegularExpressionWizard/QRegularExpressionWizardServer.py Fri Dec 22 19:45:17 2023 +0100 @@ -18,10 +18,12 @@ """ Function to validate the given regular expression. - @param regexp regular expression to validate (string) - @param options list of options (list of string) - @return tuple of flag indicating validity (boolean), error - string (string) and error offset (integer) + @param regexp regular expression to validate + @type str + @param options list of options + @type list of str + @return tuple of flag indicating validity, error string and error offset + @rtype tuple of (bool, str, int) """ rxOptions = QRegularExpression.PatternOption.NoPatternOption if "CaseInsensitiveOption" in options: @@ -54,14 +56,18 @@ """ Function to execute the given regular expression for a given text. - @param regexp regular expression to validate (string) - @param options list of options (list of string) - @param text text to execute on (string) - @param startpos start position for the execution (integer) - @return tuple of a flag indicating a successful match (boolean) and - a list of captures containing the complete match as matched string - (string), match start (integer), match end (integer) and match length - (integer) for each entry + @param regexp regular expression to validate + @type str + @param options list of options + @type list of str + @param text text to execute on + @type str + @param startpos start position for the execution + @type int + @return tuple of a flag indicating a successful match and a list of captures + containing the complete match as matched string, match start, match end + and match length for each entry + @rtype tuple of (bool, list of [str, int, int, int]) """ valid, error, errorOffset = rxValidate(regexp, options) if not valid: