Sat, 16 Jan 2021 16:51:23 +0100
Updated source docu.
--- a/eric6/Documentation/Help/source.qhp Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Help/source.qhp Sat Jan 16 16:51:23 2021 +0100 @@ -3711,6 +3711,7 @@ <keyword name="DocStyleChecker.__checkEricReturn" id="DocStyleChecker.__checkEricReturn" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkEricReturn" /> <keyword name="DocStyleChecker.__checkEricSignal" id="DocStyleChecker.__checkEricSignal" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkEricSignal" /> <keyword name="DocStyleChecker.__checkEricSummary" id="DocStyleChecker.__checkEricSummary" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkEricSummary" /> + <keyword name="DocStyleChecker.__checkEricYield" id="DocStyleChecker.__checkEricYield" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkEricYield" /> <keyword name="DocStyleChecker.__checkFunctionDocstring" id="DocStyleChecker.__checkFunctionDocstring" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkFunctionDocstring" /> <keyword name="DocStyleChecker.__checkImperativeMood" id="DocStyleChecker.__checkImperativeMood" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkImperativeMood" /> <keyword name="DocStyleChecker.__checkIndent" id="DocStyleChecker.__checkIndent" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkIndent" />
--- a/eric6/Documentation/Source/compileUiFiles.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/compileUiFiles.html Sat Jan 16 16:51:23 2021 +0100 @@ -74,7 +74,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple of directory name (string) and source file name (string) </dd>
--- a/eric6/Documentation/Source/create_windows_links.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/create_windows_links.html Sat Jan 16 16:51:23 2021 +0100 @@ -110,7 +110,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> value of requested registry variable </dd> @@ -149,7 +149,7 @@ Function to generate data for the Windows Desktop links. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of tuples containing the desktop link name, the link target and the icon target @@ -172,7 +172,7 @@ Function to generate the link names for the Windows Desktop. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of desktop link names </dd> @@ -194,7 +194,7 @@ Function to generate the name of the Start Menu top entry. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> name of the Start Menu top entry </dd>
--- a/eric6/Documentation/Source/eric6.CondaInterface.Conda.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.CondaInterface.Conda.html Sat Jan 16 16:51:23 2021 +0100 @@ -197,7 +197,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple containing a flag indicating success, the directory of the created environment (aka. prefix) and the corresponding Python @@ -218,7 +218,7 @@ Public method to get a list of all Conda environments. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of tuples containing the environment name and prefix </dd> @@ -237,7 +237,7 @@ Public method to get a dictionary containing information about conda. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> dictionary containing information about conda </dd> @@ -268,7 +268,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of installed packages. Each entry is a tuple containing the package name, version and build. @@ -308,7 +308,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of installed packages. Each entry is a tuple containing the package name, version and build. @@ -351,7 +351,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating success </dd> @@ -389,7 +389,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating success </dd> @@ -427,7 +427,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple containing a flag indicating success and the output of the process @@ -474,7 +474,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating success and a dictionary with package name as key and list of dictionaries containing detailed data for the found @@ -519,7 +519,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating success </dd> @@ -557,7 +557,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating success </dd> @@ -584,7 +584,7 @@ Public method to update conda itself. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating success </dd> @@ -618,7 +618,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating success </dd>
--- a/eric6/Documentation/Source/eric6.CondaInterface.CondaExecDialog.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.CondaInterface.CondaExecDialog.html Sat Jan 16 16:51:23 2021 +0100 @@ -228,7 +228,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating success </dd> @@ -247,7 +247,7 @@ Public method to the result of the command execution. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple containing a flag indicating success and the result data. </dd>
--- a/eric6/Documentation/Source/eric6.CondaInterface.CondaNewEnvironmentDataDialog.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.CondaInterface.CondaNewEnvironmentDataDialog.html Sat Jan 16 16:51:23 2021 +0100 @@ -137,7 +137,7 @@ Public method to get the entered data. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple with the logical name of the new environment, the conda name and the requirements file name
--- a/eric6/Documentation/Source/eric6.CondaInterface.CondaPackagesWidget.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.CondaInterface.CondaPackagesWidget.html Sat Jan 16 16:51:23 2021 +0100 @@ -259,7 +259,7 @@ Private method to get a list of all items that can be updated. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of all items that can be updated </dd> @@ -363,7 +363,7 @@ Private method to get a list of selected items that can be updated. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of selected items that can be updated </dd>
--- a/eric6/Documentation/Source/eric6.CondaInterface.__init__.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.CondaInterface.__init__.html Sat Jan 16 16:51:23 2021 +0100 @@ -88,7 +88,7 @@ Module function to get the conda version. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple containing the conda version </dd> @@ -110,7 +110,7 @@ Module function to get the conda version as a string. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> conda version as a string </dd> @@ -132,7 +132,7 @@ Module function to check the availability of conda. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating conda availability </dd> @@ -164,7 +164,7 @@ Module function to get the root prefix. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> root prefix </dd> @@ -186,7 +186,7 @@ Module function to get the path of the user configuration file. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> path of the user configuration file </dd>
--- a/eric6/Documentation/Source/eric6.Cooperation.ChatWidget.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Cooperation.ChatWidget.html Sat Jan 16 16:51:23 2021 +0100 @@ -362,7 +362,7 @@ Private method to determine the connection parameters. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple with hostname and port (string, integer) </dd> @@ -533,7 +533,7 @@ Public method to get a reference to the cooperation client. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the cooperation client (CooperationClient) </dd>
--- a/eric6/Documentation/Source/eric6.Cooperation.Connection.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Cooperation.Connection.html Sat Jan 16 16:51:23 2021 +0100 @@ -206,7 +206,7 @@ Private method to get the data length for the current data type. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> data length (integer) </dd> @@ -226,7 +226,7 @@ Private method to check, if enough data is available. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating availability of enough data (boolean) </dd> @@ -260,7 +260,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> size of data read (integer) </dd> @@ -273,7 +273,7 @@ Private method to read the protocol header. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a successful read (boolean) </dd> @@ -300,7 +300,7 @@ Public method to get the connection name. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> connection name (string) </dd> @@ -350,7 +350,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a successful send (boolean) </dd> @@ -378,7 +378,7 @@ Public method to get the server port. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> server port (integer) </dd>
--- a/eric6/Documentation/Source/eric6.Cooperation.CooperationClient.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Cooperation.CooperationClient.html Sat Jan 16 16:51:23 2021 +0100 @@ -282,7 +282,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of references to the connection objects (list of Connection) @@ -382,7 +382,7 @@ Public method to get a reference to the chat widget. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the chat widget (ChatWidget) </dd> @@ -428,7 +428,7 @@ server error. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> human readable error message about the last server error (string) @@ -453,7 +453,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating an existing connection (boolean) </dd> @@ -466,7 +466,7 @@ Public method to check, if there are any connections established. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the presence of connections (boolean) </dd> @@ -479,7 +479,7 @@ Public method to check, if the client is listening for connections. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the listening state (boolean) </dd> @@ -506,7 +506,7 @@ Public method to get the nick name. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> nick name (string) </dd> @@ -578,7 +578,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple giving a flag indicating success (boolean) and the port the server listens on
--- a/eric6/Documentation/Source/eric6.Cooperation.CooperationServer.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Cooperation.CooperationServer.html Sat Jan 16 16:51:23 2021 +0100 @@ -148,7 +148,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple giving a flag indicating success (boolean) and the port the server listens on
--- a/eric6/Documentation/Source/eric6.DataViews.CodeMetrics.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DataViews.CodeMetrics.html Sat Jan 16 16:51:23 2021 +0100 @@ -253,7 +253,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the value of the requested counter (int) </dd> @@ -380,7 +380,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> a statistics object with the collected code statistics (SourceStat) </dd> @@ -411,7 +411,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the value added to the overall statistics </dd>
--- a/eric6/Documentation/Source/eric6.DataViews.CodeMetricsDialog.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DataViews.CodeMetricsDialog.html Sat Jan 16 16:51:23 2021 +0100 @@ -164,7 +164,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the generated item </dd> @@ -218,7 +218,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of values suitable for display (list of strings) </dd>
--- a/eric6/Documentation/Source/eric6.DataViews.PyCoverageDialog.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DataViews.PyCoverageDialog.html Sat Jan 16 16:51:23 2021 +0100 @@ -251,7 +251,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> string representing the list </dd>
--- a/eric6/Documentation/Source/eric6.DataViews.PyProfileDialog.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DataViews.PyProfileDialog.html Sat Jan 16 16:51:23 2021 +0100 @@ -103,7 +103,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> comparison value for the first column (integer) </dd> @@ -124,7 +124,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> true, if this item is less than other (boolean) </dd>
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.AsyncFile.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DebugClients.Python.AsyncFile.html Sat Jan 16 16:51:23 2021 +0100 @@ -237,7 +237,7 @@ Public method returning the file number. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> file number </dd> @@ -263,7 +263,7 @@ Public method to indicate whether a tty interface is supported. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> always false </dd> @@ -282,7 +282,7 @@ Public method that returns the number of strings waiting to be written. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the number of strings to be written </dd> @@ -308,7 +308,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the bytes read </dd> @@ -327,7 +327,7 @@ Public method to read a length prefixed command string. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> command string </dd> @@ -353,7 +353,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the bytes read </dd> @@ -372,7 +372,7 @@ Public method to check, if the stream is readable. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a readable stream </dd> @@ -398,7 +398,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> one line read </dd> @@ -428,7 +428,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> one line of text up to size bytes </dd> @@ -454,7 +454,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of lines read </dd> @@ -499,7 +499,7 @@ Public method to check, if the stream is seekable. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a seekable stream </dd> @@ -555,7 +555,7 @@ Public method to check, if a stream is writable. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a writable stream </dd> @@ -626,7 +626,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> Flag indicating if there is data waiting </dd>
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.BreakpointWatch.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DebugClients.Python.BreakpointWatch.html Sat Jan 16 16:51:23 2021 +0100 @@ -226,7 +226,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple of Breakpoint and a flag to indicate, that a temporary breakpoint may be deleted @@ -261,7 +261,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> Breakpoint or None, if there is no bp </dd> @@ -423,7 +423,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple of watch expression and a flag to indicate, that a temporary watch expression may be deleted @@ -450,7 +450,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the watch point </dd>
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.DebugBase.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DebugClients.Python.DebugBase.html Sat Jan 16 16:51:23 2021 +0100 @@ -272,7 +272,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> Flag indicating a function / method with breakpoint </dd> @@ -298,7 +298,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> dictionary containing the disassembly information </dd> @@ -364,7 +364,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> exception name (string) </dd> @@ -384,7 +384,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> SystemExit code and message </dd> @@ -410,7 +410,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of stack frames </dd> @@ -456,7 +456,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating whether the debugger should skip this frame </dd> @@ -536,7 +536,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the break status </dd> @@ -574,7 +574,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> fixed up file name </dd> @@ -593,7 +593,7 @@ Public method to return the current frame. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the current frame </dd> @@ -621,7 +621,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> locals dictionary of the frame </dd> @@ -645,7 +645,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of lists with file name (string), line number (integer) and function name (string) @@ -767,7 +767,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> exit code of the program </dd> @@ -930,7 +930,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating whether the debugger should stop here </dd> @@ -999,7 +999,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> local trace function </dd>
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.DebugClientBase.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DebugClients.Python.DebugClientBase.html Sat Jan 16 16:51:23 2021 +0100 @@ -324,7 +324,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of tuples containing the test case ID, a short description and the path of the test file name @@ -344,7 +344,7 @@ Private method to determine the clients capabilities. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> client capabilities (integer) </dd> @@ -372,7 +372,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> compiled code object (None in case of errors) </dd> @@ -396,7 +396,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> compiled code object (None in case of errors) </dd> @@ -478,7 +478,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple containing the variable text without indicators and the indicator string @@ -509,7 +509,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> A tuple consisting of a list of formatted variables. Each variable entry is a tuple of three elements, the variable name, @@ -551,7 +551,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> A tuple consisting of a list of formatted variables. Each variable entry is a tuple of three elements, the variable name, @@ -621,7 +621,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> path list for use as sys.path (list of strings) </dd> @@ -655,7 +655,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> IP address (string) </dd> @@ -733,7 +733,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the converted filename (string) </dd> @@ -818,7 +818,7 @@ Public method to return the current coding. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> codec name (string) </dd> @@ -831,7 +831,7 @@ Public method to return the main script we are currently running. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a running debug session (boolean) </dd> @@ -869,7 +869,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the entered string </dd> @@ -918,7 +918,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating an error condition </dd> @@ -952,7 +952,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> result of the function call </dd> @@ -1184,7 +1184,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating eligibility </dd> @@ -1303,7 +1303,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> exit code of the debugged program </dd> @@ -1366,7 +1366,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> result of the input() call </dd>
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.DebugUtilities.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DebugClients.Python.DebugUtilities.html Sat Jan 16 16:51:23 2021 +0100 @@ -110,7 +110,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple of four things, where 'args' and 'kwonlyargs' are lists of argument names, and 'varargs' and 'varkw' are the names of the @@ -171,7 +171,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> formatted call signature </dd> @@ -201,7 +201,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple of four things, where 'args' is a list of the argument names, 'varargs' and 'varkw' are the names of the * and ** arguments or None @@ -233,7 +233,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating an executable program </dd> @@ -263,7 +263,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a Python interpreter or program </dd> @@ -285,7 +285,7 @@ Function to check, if this is a Windows platform. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating Windows platform </dd> @@ -318,7 +318,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> patched argument string </dd> @@ -356,7 +356,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> modified argument list </dd> @@ -390,7 +390,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> prepared JSON command or response string </dd> @@ -419,7 +419,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of quoted arguments </dd> @@ -448,7 +448,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of unquoted strings </dd> @@ -477,7 +477,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating an existing and valid shebang line </dd> @@ -506,7 +506,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of command arguments </dd>
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.DebugVariables.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DebugClients.Python.DebugVariables.html Sat Jan 16 16:51:23 2021 +0100 @@ -138,15 +138,16 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Yield:</dt> <dd> -dictionary containing the variable attributes +tuple containing the batch start index and a dictionary + containing the variable attributes </dd> </dl> <dl> -<dt>Return Type:</dt> +<dt>Yield Type:</dt> <dd> -dict +tuple of (int, dict) </dd> </dl> <a NAME="ArrayResolver.resolve" ID="ArrayResolver.resolve"></a> @@ -168,7 +169,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> value of the attribute </dd> @@ -234,7 +235,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> dictionary containing the variable attributes </dd> @@ -264,7 +265,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> value of the attribute </dd> @@ -326,15 +327,16 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Yield:</dt> <dd> -dictionary containing the variable attributes +tuple containing the batch start index and a dictionary + containing the variable attributes </dd> </dl> <dl> -<dt>Return Type:</dt> +<dt>Yield Type:</dt> <dd> -dict +tuple of (int, dict) </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -396,15 +398,16 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Yield:</dt> <dd> -dictionary containing the variable attributes +tuple containing the batch start index and a dictionary + containing the variable attributes </dd> </dl> <dl> -<dt>Return Type:</dt> +<dt>Yield Type:</dt> <dd> -dict +tuple of (int, dict) </dd> </dl> <a NAME="DictResolver.keyToStr" ID="DictResolver.keyToStr"></a> @@ -422,7 +425,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> string representation of the given key </dd> @@ -452,7 +455,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> value of the attribute </dd> @@ -518,7 +521,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> dictionary containing the variable attributes </dd> @@ -548,7 +551,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> value of the attribute </dd> @@ -614,15 +617,16 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Yield:</dt> <dd> -dictionary containing the variable attributes +tuple containing the batch start index and a dictionary + containing the variable attributes </dd> </dl> <dl> -<dt>Return Type:</dt> +<dt>Yield Type:</dt> <dd> -dict +tuple of (int, dict) </dd> </dl> <a NAME="ListResolver.resolve" ID="ListResolver.resolve"></a> @@ -644,7 +648,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> value of the attribute </dd> @@ -710,15 +714,16 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Yield:</dt> <dd> -dictionary containing the variable attributes +tuple containing the batch start index and a dictionary + containing the variable attributes </dd> </dl> <dl> -<dt>Return Type:</dt> +<dt>Yield Type:</dt> <dd> -dict +tuple of (int, dict) </dd> </dl> <a NAME="MultiValueDictResolver.resolve" ID="MultiValueDictResolver.resolve"></a> @@ -740,7 +745,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> value of the attribute </dd> @@ -810,7 +815,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a numeric array </dd> @@ -836,15 +841,16 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Yield:</dt> <dd> -dictionary containing the variable attributes +tuple containing the batch start index and a dictionary + containing the variable attributes </dd> </dl> <dl> -<dt>Return Type:</dt> +<dt>Yield Type:</dt> <dd> -dict +tuple of (int, dict) </dd> </dl> <a NAME="NdArrayResolver.resolve" ID="NdArrayResolver.resolve"></a> @@ -866,7 +872,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> value of the attribute </dd> @@ -932,15 +938,16 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Yield:</dt> <dd> -dictionary containing the variable attributes +tuple containing the batch start index and a dictionary + containing the variable attributes </dd> </dl> <dl> -<dt>Return Type:</dt> +<dt>Yield Type:</dt> <dd> -dict +tuple of (int, dict) </dd> </dl> <a NAME="SetResolver.resolve" ID="SetResolver.resolve"></a> @@ -962,7 +969,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> value of the attribute </dd> @@ -1001,7 +1008,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple containing the type name, type string and resolver </dd>
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.FlexCompleter.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DebugClients.Python.FlexCompleter.html Sat Jan 16 16:51:23 2021 +0100 @@ -207,7 +207,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> ammended word (string) </dd> @@ -237,7 +237,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> A list of all matches. </dd> @@ -265,7 +265,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The possible completions as a list of strings. </dd> @@ -285,7 +285,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> A list of all keywords, built-in functions and names currently defined in self.namespace that match. @@ -309,7 +309,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> A list of all names defined in the class. </dd>
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.ModuleLoader.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DebugClients.Python.ModuleLoader.html Sat Jan 16 16:51:23 2021 +0100 @@ -124,7 +124,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the loaded module </dd> @@ -150,7 +150,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> created and patched module </dd> @@ -199,7 +199,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> module spec object pointing to the module loader </dd>
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.MultiProcessDebugExtension.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DebugClients.Python.MultiProcessDebugExtension.html Sat Jan 16 16:51:23 2021 +0100 @@ -143,7 +143,7 @@ Function to determine, if the multiprocessing patches should be done. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating patching should be performed </dd> @@ -173,7 +173,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> function replacing the original one </dd> @@ -210,7 +210,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> function replacing the original one </dd> @@ -245,7 +245,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> function replacing the original one </dd> @@ -280,7 +280,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> function replacing the original one </dd> @@ -314,7 +314,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> function replacing the original one </dd> @@ -349,7 +349,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> function replacing the original one </dd> @@ -386,7 +386,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> function replacing the original one </dd> @@ -421,7 +421,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> function replacing the original one </dd> @@ -456,7 +456,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> function replacing the original one </dd> @@ -491,7 +491,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> function replacing the original one </dd>
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.MultiprocessingExtension.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DebugClients.Python.MultiprocessingExtension.html Sat Jan 16 16:51:23 2021 +0100 @@ -103,7 +103,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> exit code of the process </dd>
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.PyProfile.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DebugClients.Python.PyProfile.html Sat Jan 16 16:51:23 2021 +0100 @@ -186,7 +186,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> fixed up file name (string) </dd> @@ -221,7 +221,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a successful handling (boolean) </dd>
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.QProcessExtension.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DebugClients.Python.QProcessExtension.html Sat Jan 16 16:51:23 2021 +0100 @@ -131,7 +131,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a successful start </dd> @@ -189,7 +189,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a successful start </dd> @@ -224,7 +224,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a successful start </dd>
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.ThreadExtension.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DebugClients.Python.ThreadExtension.html Sat Jan 16 16:51:23 2021 +0100 @@ -356,7 +356,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> identifier of the created thread </dd> @@ -383,7 +383,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the frame which is excecuted (without debugger frames) </dd> @@ -409,7 +409,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating successful locking </dd> @@ -435,7 +435,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating that the module was processed </dd>
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.eric6dbgstub.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DebugClients.Python.eric6dbgstub.html Sat Jan 16 16:51:23 2021 +0100 @@ -73,7 +73,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating success (boolean) </dd> @@ -107,7 +107,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the function result </dd>
--- a/eric6/Documentation/Source/eric6.DebugClients.Python.getpass.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DebugClients.Python.getpass.html Sat Jan 16 16:51:23 2021 +0100 @@ -73,7 +73,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> Password entered by the user </dd> @@ -99,7 +99,7 @@ database. This works on Windows as long as USERNAME is set. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> username </dd>
--- a/eric6/Documentation/Source/eric6.Debugger.BreakPointModel.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Debugger.BreakPointModel.html Sat Jan 16 16:51:23 2021 +0100 @@ -212,7 +212,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> column count </dd> @@ -242,7 +242,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the requested data </dd> @@ -303,7 +303,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> item flags for the given index </dd> @@ -329,7 +329,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> breakpoint (list of six values (filename, line number, condition, temporary flag, enabled flag, ignore count)) @@ -361,7 +361,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> index </dd> @@ -387,7 +387,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the presence of child items </dd> @@ -421,7 +421,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> header data </dd> @@ -455,7 +455,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> requested index </dd> @@ -481,7 +481,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a temporary breakpoint </dd> @@ -507,7 +507,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> index of parent </dd> @@ -533,7 +533,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> row count </dd> @@ -612,7 +612,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating success </dd>
--- a/eric6/Documentation/Source/eric6.Debugger.BreakPointViewer.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Debugger.BreakPointViewer.html Sat Jan 16 16:51:23 2021 +0100 @@ -377,7 +377,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> mapped index </dd> @@ -396,7 +396,7 @@ Private method to get the count of items selected. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> count of items selected </dd> @@ -522,7 +522,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> mapped index </dd>
--- a/eric6/Documentation/Source/eric6.Debugger.CallTraceViewer.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Debugger.CallTraceViewer.html Sat Jan 16 16:51:23 2021 +0100 @@ -263,7 +263,7 @@ Public method to get the state of the call trace function. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the state of the call trace function </dd>
--- a/eric6/Documentation/Source/eric6.Debugger.DebugServer.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Debugger.DebugServer.html Sat Jan 16 16:51:23 2021 +0100 @@ -1001,7 +1001,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> associated language </dd> @@ -1028,7 +1028,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple of network interface name and index </dd> @@ -1058,7 +1058,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> condition string </dd> @@ -1288,7 +1288,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple of local expression (string) and special condition </dd> @@ -1515,7 +1515,7 @@ Public slot to get a reference to the breakpoint model object. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the breakpoint model object </dd> @@ -1541,7 +1541,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> debug client capabilities </dd> @@ -1560,7 +1560,7 @@ Public method to get the interpreter of the debug client. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> interpreter of the debug client </dd> @@ -1579,7 +1579,7 @@ Public method to get the currently running debug client type. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> debug client type </dd> @@ -1598,7 +1598,7 @@ Public method to return the IDs of the connected debugger backends. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of connected debugger backend IDs </dd> @@ -1624,7 +1624,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple of extensions associated with the language </dd> @@ -1651,7 +1651,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> IP address or hostname </dd> @@ -1678,7 +1678,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of supported languages </dd> @@ -1697,7 +1697,7 @@ Public slot to get a reference to the watch expression model object. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the watch expression model object </dd> @@ -1730,7 +1730,7 @@ Public method to check, if the debug client process is up. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a running debug client process </dd> @@ -1749,7 +1749,7 @@ Public method to test, if the debug server is connected to a backend. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a connection </dd> @@ -1768,7 +1768,7 @@ Public method to test, if the debug server is debugging. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the debugging state </dd>
--- a/eric6/Documentation/Source/eric6.Debugger.DebugUI.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Debugger.DebugUI.html Sat Jan 16 16:51:23 2021 +0100 @@ -1298,7 +1298,7 @@ Public method to get a list of all actions. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of all actions (list of E5Action) </dd> @@ -1311,7 +1311,7 @@ Public method to get the currently selected debugger ID. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> selected debugger ID </dd> @@ -1337,7 +1337,7 @@ Public slot to initialize the project menu. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the generated menu </dd> @@ -1358,7 +1358,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the generated toolbars (list of QToolBar) </dd> @@ -1597,7 +1597,7 @@ This is needed to cleanly close the sockets on Win OS. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> always true </dd> @@ -1617,7 +1617,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> filters list </dd>
--- a/eric6/Documentation/Source/eric6.Debugger.DebugViewer.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Debugger.DebugViewer.html Sat Jan 16 16:51:23 2021 +0100 @@ -564,7 +564,7 @@ Public method to get a reference to the current widget. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the current widget </dd> @@ -583,7 +583,7 @@ Public method to get the currently selected debugger ID. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> selected debugger ID </dd> @@ -602,7 +602,7 @@ Public method to get the currently selected debugger's state. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> selected debugger's state (broken, exception, running) </dd> @@ -685,7 +685,7 @@ Public method to get the state of the call trace function. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the state of the call trace function </dd> @@ -704,7 +704,7 @@ Public method to test, if only one debugger is connected. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating that only one debugger is connected </dd>
--- a/eric6/Documentation/Source/eric6.Debugger.DebuggerInterfaceNone.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Debugger.DebuggerInterfaceNone.html Sat Jan 16 16:51:23 2021 +0100 @@ -285,7 +285,7 @@ Public method to retrieve the debug clients capabilities. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> debug client capabilities </dd> @@ -304,7 +304,7 @@ Public method to return the IDs of the connected debugger backends. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of connected debugger backend IDs </dd> @@ -323,7 +323,7 @@ Public method to test, if a debug client has connected. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the connection status </dd> @@ -349,7 +349,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating success </dd> @@ -1176,7 +1176,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> client process object, a flag to indicate a network connection and the name of the interpreter in case of a local execution @@ -1220,7 +1220,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> client process object, a flag to indicate a network connection and the name of the interpreter in case of a local execution @@ -1257,7 +1257,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> instantiated debugger interface </dd> @@ -1279,7 +1279,7 @@ Module function to get characterizing data for the debugger interface. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of tuples containing the client type, the client capabilities, the client file type associations and a reference to the creation
--- a/eric6/Documentation/Source/eric6.Debugger.DebuggerInterfacePython.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Debugger.DebuggerInterfacePython.html Sat Jan 16 16:51:23 2021 +0100 @@ -388,7 +388,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> translated filename </dd> @@ -433,7 +433,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> translated filename </dd> @@ -526,7 +526,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the process object </dd> @@ -563,7 +563,7 @@ Public method to retrieve the debug clients capabilities. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> debug client capabilities </dd> @@ -582,7 +582,7 @@ Public method to return the IDs of the connected debugger backends. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of connected debugger backend IDs </dd> @@ -601,7 +601,7 @@ Public method to test, if a debug client has connected. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the connection status </dd> @@ -627,7 +627,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating success </dd> @@ -1454,7 +1454,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> client process object, a flag to indicate a network connection and the name of the interpreter in case of a local execution @@ -1498,7 +1498,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> client process object, a flag to indicate a network connection and the name of the interpreter in case of a local execution @@ -1535,7 +1535,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> instantiated debugger interface </dd> @@ -1558,7 +1558,7 @@ interfaces. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of tuples containing the client type, the client capabilities, the client file type associations and a reference to the creation
--- a/eric6/Documentation/Source/eric6.Debugger.EditBreakpointDialog.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Debugger.EditBreakpointDialog.html Sat Jan 16 16:51:23 2021 +0100 @@ -144,7 +144,7 @@ Public method to retrieve the entered data for an add. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> a tuple containing the new breakpoints properties (filename, lineno, condition, temporary flag, enabled flag, @@ -159,7 +159,7 @@ Public method to retrieve the entered data. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> a tuple containing the breakpoints new properties (condition, temporary flag, enabled flag, ignore count)
--- a/eric6/Documentation/Source/eric6.Debugger.EditWatchpointDialog.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Debugger.EditWatchpointDialog.html Sat Jan 16 16:51:23 2021 +0100 @@ -138,7 +138,7 @@ Public method to retrieve the entered data. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> a tuple containing the watch expressions new properties (expression, temporary flag, enabled flag, ignore count,
--- a/eric6/Documentation/Source/eric6.Debugger.ExceptionsFilterDialog.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Debugger.ExceptionsFilterDialog.html Sat Jan 16 16:51:23 2021 +0100 @@ -133,7 +133,7 @@ Public method to retrieve the list of exception types. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of exception types (list of strings) </dd>
--- a/eric6/Documentation/Source/eric6.Debugger.StartDialog.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Debugger.StartDialog.html Sat Jan 16 16:51:23 2021 +0100 @@ -230,7 +230,7 @@ Public method to test, if histories shall be cleared. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating histories shall be cleared </dd> @@ -250,7 +250,7 @@ dialog. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating erasure of coverage info </dd> @@ -269,7 +269,7 @@ Public method to retrieve the data entered into this dialog. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> a tuple of interpreter, argv, workdir, environment, exceptions flag, clear interpreter flag and run in console flag @@ -290,7 +290,7 @@ dialog. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> a tuple of a flag indicating, if the Python library should be traced as well, a flag indicating, that the debugger should not @@ -313,7 +313,7 @@ Public method to get the lists of histories. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple containing the histories of command line arguments, working directories, environment settings and no debug programs @@ -335,7 +335,7 @@ dialog. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating erasure of profiling info </dd> @@ -354,7 +354,7 @@ Public method to test for modified histories. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating modified histories </dd>
--- a/eric6/Documentation/Source/eric6.Debugger.StartHistoryEditDialog.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Debugger.StartHistoryEditDialog.html Sat Jan 16 16:51:23 2021 +0100 @@ -136,7 +136,7 @@ Public method to get the new list of history entries. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of history entries </dd>
--- a/eric6/Documentation/Source/eric6.Debugger.VariablesFilterDialog.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Debugger.VariablesFilterDialog.html Sat Jan 16 16:51:23 2021 +0100 @@ -125,7 +125,7 @@ Public slot to retrieve the current selections. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple of lists containing the variable filters. The first list is the locals variables filter, the second the globals variables
--- a/eric6/Documentation/Source/eric6.Debugger.VariablesViewer.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Debugger.VariablesViewer.html Sat Jan 16 16:51:23 2021 +0100 @@ -194,7 +194,7 @@ Public property to get the total number of children. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> total number of children </dd> @@ -355,7 +355,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of names denoting the path from the root </dd> @@ -404,7 +404,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> next item index to request data from debugger </dd> @@ -430,7 +430,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the found variable or None if it doesn't exist </dd> @@ -470,7 +470,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> number of columns </dd> @@ -500,7 +500,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> role data of item </dd> @@ -526,7 +526,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> item flags </dd> @@ -566,7 +566,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating parent has children </dd> @@ -600,7 +600,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> header name </dd> @@ -634,7 +634,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> new model index for child </dd> @@ -660,7 +660,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> new model index for parent </dd> @@ -704,7 +704,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> number of rows </dd> @@ -838,7 +838,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag if parent has children </dd>
--- a/eric6/Documentation/Source/eric6.Debugger.WatchPointModel.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Debugger.WatchPointModel.html Sat Jan 16 16:51:23 2021 +0100 @@ -205,7 +205,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> column count (integer) </dd> @@ -229,7 +229,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the requested data </dd> @@ -285,7 +285,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> item flags for the given index (Qt.ItemFlags) </dd> @@ -305,7 +305,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> watch expression (list of six values (expression, special condition, temporary flag, enabled flag, ignore count, @@ -332,7 +332,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> index (QModelIndex) </dd> @@ -352,7 +352,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the presence of child items (boolean) </dd> @@ -380,7 +380,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> header data </dd> @@ -408,7 +408,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> requested index (QModelIndex) </dd> @@ -428,7 +428,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> index of parent (QModelIndex) </dd> @@ -448,7 +448,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> row count (integer) </dd>
--- a/eric6/Documentation/Source/eric6.Debugger.WatchPointViewer.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Debugger.WatchPointViewer.html Sat Jan 16 16:51:23 2021 +0100 @@ -370,7 +370,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a duplicate entry (boolean) </dd> @@ -390,7 +390,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> mapped index (QModelIndex) </dd> @@ -403,7 +403,7 @@ Private method to get the count of items selected. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> count of items selected (integer) </dd> @@ -503,7 +503,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> mapped index (QModelIndex) </dd>
--- a/eric6/Documentation/Source/eric6.DocumentationTools.APIGenerator.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DocumentationTools.APIGenerator.html Sat Jan 16 16:51:23 2021 +0100 @@ -190,7 +190,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating, that object is considered private (boolean) </dd> @@ -220,7 +220,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> API information (list of strings) </dd> @@ -241,7 +241,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> base classes information (dictionary of list of strings) </dd>
--- a/eric6/Documentation/Source/eric6.DocumentationTools.IndexGenerator.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DocumentationTools.IndexGenerator.html Sat Jan 16 16:51:23 2021 +0100 @@ -139,7 +139,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The name of the generated index file. </dd>
--- a/eric6/Documentation/Source/eric6.DocumentationTools.ModuleDocumentor.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DocumentationTools.ModuleDocumentor.html Sat Jan 16 16:51:23 2021 +0100 @@ -239,7 +239,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the deprecation status (boolean) </dd> @@ -262,7 +262,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> formatted entry (string) </dd> @@ -282,9 +282,9 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> -The formated contents of the documentation string. (string) +The formatted contents of the documentation string. (string) </dd> </dl> <dl> @@ -304,7 +304,7 @@ module. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The classes list section. (string) </dd> @@ -318,7 +318,7 @@ classes. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The classes details section. (string) </dd> @@ -343,7 +343,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The list section. (string) </dd> @@ -357,7 +357,7 @@ module. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The functions list section. (string) </dd> @@ -371,7 +371,7 @@ functions. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The functions details section. (string) </dd> @@ -392,7 +392,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The globals list section. (string) </dd> @@ -421,7 +421,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list section (string) </dd> @@ -449,7 +449,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> method list and method details section (tuple of two string) </dd> @@ -487,7 +487,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> methods list section (string) </dd> @@ -500,7 +500,7 @@ Private method to generate the body of the document. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The body of the document. (string) </dd> @@ -525,7 +525,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> Ready formatted paragraphs. (string) </dd> @@ -546,7 +546,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> formatted list section (string) </dd> @@ -576,7 +576,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The list section. (string) </dd> @@ -600,7 +600,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The classes list and classes details section. (tuple of two string) @@ -615,7 +615,7 @@ (Ruby only). </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The modules list section. (string) </dd> @@ -629,7 +629,7 @@ Ruby modules. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The Ruby modules details section. (string) </dd> @@ -654,7 +654,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The list section. (string) </dd> @@ -678,7 +678,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The short description. (string) </dd> @@ -698,7 +698,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> processed line with inline tags expanded (string) </dd> @@ -718,7 +718,7 @@ Public method used to get the description of the module. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The description of the module. (string) </dd> @@ -731,7 +731,7 @@ Public method to generate the source code documentation. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The source code documentation. (string) </dd> @@ -744,7 +744,7 @@ Public method to retrieve the parts for the QtHelp keywords section. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of tuples containing the name (string) and the ref (string). The ref is without the filename part. @@ -759,7 +759,7 @@ functions. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> Flag indicating an empty module (i.e. __init__.py without any contents) @@ -773,7 +773,7 @@ Public method used to get the module name. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The name of the module. (string) </dd> @@ -790,7 +790,7 @@ description. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> The short description of the module. (string) </dd>
--- a/eric6/Documentation/Source/eric6.DocumentationTools.QtHelpGenerator.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DocumentationTools.QtHelpGenerator.html Sat Jan 16 16:51:23 2021 +0100 @@ -160,7 +160,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> converted text (string) </dd> @@ -184,7 +184,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> sections part (string) </dd>
--- a/eric6/Documentation/Source/eric6.DocumentationTools.TemplatesListsStyle.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DocumentationTools.TemplatesListsStyle.html Sat Jan 16 16:51:23 2021 +0100 @@ -28,7 +28,7 @@ <h3>Global Attributes</h3> <table> -<tr><td>authorInfoTemplate</td></tr><tr><td>classTemplate</td></tr><tr><td>constructorTemplate</td></tr><tr><td>deprecatedTemplate</td></tr><tr><td>eventsListEntryTemplate</td></tr><tr><td>eventsListTemplate</td></tr><tr><td>exceptionsListEntryTemplate</td></tr><tr><td>exceptionsListTemplate</td></tr><tr><td>footerTemplate</td></tr><tr><td>functionTemplate</td></tr><tr><td>headerTemplate</td></tr><tr><td>indexBodyTemplate</td></tr><tr><td>indexListEntryTemplate</td></tr><tr><td>indexListModulesTemplate</td></tr><tr><td>indexListPackagesTemplate</td></tr><tr><td>listEntryDeprecatedTemplate</td></tr><tr><td>listEntryNoneTemplate</td></tr><tr><td>listEntrySimpleTemplate</td></tr><tr><td>listEntryTemplate</td></tr><tr><td>listTemplate</td></tr><tr><td>methodTemplate</td></tr><tr><td>moduleTemplate</td></tr><tr><td>paragraphTemplate</td></tr><tr><td>parameterTypesListEntryTemplate</td></tr><tr><td>parametersListEntryTemplate</td></tr><tr><td>parametersListTemplate</td></tr><tr><td>rbFileTemplate</td></tr><tr><td>rbModuleTemplate</td></tr><tr><td>rbModulesClassTemplate</td></tr><tr><td>returnTypesTemplate</td></tr><tr><td>returnsTemplate</td></tr><tr><td>seeLinkTemplate</td></tr><tr><td>seeListEntryTemplate</td></tr><tr><td>seeListTemplate</td></tr><tr><td>signalsListEntryTemplate</td></tr><tr><td>signalsListTemplate</td></tr><tr><td>sinceInfoTemplate</td></tr> +<tr><td>authorInfoTemplate</td></tr><tr><td>classTemplate</td></tr><tr><td>constructorTemplate</td></tr><tr><td>deprecatedTemplate</td></tr><tr><td>eventsListEntryTemplate</td></tr><tr><td>eventsListTemplate</td></tr><tr><td>exceptionsListEntryTemplate</td></tr><tr><td>exceptionsListTemplate</td></tr><tr><td>footerTemplate</td></tr><tr><td>functionTemplate</td></tr><tr><td>headerTemplate</td></tr><tr><td>indexBodyTemplate</td></tr><tr><td>indexListEntryTemplate</td></tr><tr><td>indexListModulesTemplate</td></tr><tr><td>indexListPackagesTemplate</td></tr><tr><td>listEntryDeprecatedTemplate</td></tr><tr><td>listEntryNoneTemplate</td></tr><tr><td>listEntrySimpleTemplate</td></tr><tr><td>listEntryTemplate</td></tr><tr><td>listTemplate</td></tr><tr><td>methodTemplate</td></tr><tr><td>moduleTemplate</td></tr><tr><td>paragraphTemplate</td></tr><tr><td>parameterTypesListEntryTemplate</td></tr><tr><td>parametersListEntryTemplate</td></tr><tr><td>parametersListTemplate</td></tr><tr><td>rbFileTemplate</td></tr><tr><td>rbModuleTemplate</td></tr><tr><td>rbModulesClassTemplate</td></tr><tr><td>returnTypesTemplate</td></tr><tr><td>returnsTemplate</td></tr><tr><td>seeLinkTemplate</td></tr><tr><td>seeListEntryTemplate</td></tr><tr><td>seeListTemplate</td></tr><tr><td>signalsListEntryTemplate</td></tr><tr><td>signalsListTemplate</td></tr><tr><td>sinceInfoTemplate</td></tr><tr><td>yieldTypesTemplate</td></tr><tr><td>yieldsTemplate</td></tr> </table> <h3>Classes</h3>
--- a/eric6/Documentation/Source/eric6.DocumentationTools.TemplatesListsStyleCSS.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.DocumentationTools.TemplatesListsStyleCSS.html Sat Jan 16 16:51:23 2021 +0100 @@ -28,7 +28,7 @@ <h3>Global Attributes</h3> <table> -<tr><td>authorInfoTemplate</td></tr><tr><td>classTemplate</td></tr><tr><td>constructorTemplate</td></tr><tr><td>deprecatedTemplate</td></tr><tr><td>eventsListEntryTemplate</td></tr><tr><td>eventsListTemplate</td></tr><tr><td>exceptionsListEntryTemplate</td></tr><tr><td>exceptionsListTemplate</td></tr><tr><td>footerTemplate</td></tr><tr><td>functionTemplate</td></tr><tr><td>headerTemplate</td></tr><tr><td>indexBodyTemplate</td></tr><tr><td>indexListEntryTemplate</td></tr><tr><td>indexListModulesTemplate</td></tr><tr><td>indexListPackagesTemplate</td></tr><tr><td>listEntryDeprecatedTemplate</td></tr><tr><td>listEntryNoneTemplate</td></tr><tr><td>listEntrySimpleTemplate</td></tr><tr><td>listEntryTemplate</td></tr><tr><td>listTemplate</td></tr><tr><td>methodTemplate</td></tr><tr><td>moduleTemplate</td></tr><tr><td>paragraphTemplate</td></tr><tr><td>parameterTypesListEntryTemplate</td></tr><tr><td>parametersListEntryTemplate</td></tr><tr><td>parametersListTemplate</td></tr><tr><td>rbFileTemplate</td></tr><tr><td>rbModuleTemplate</td></tr><tr><td>rbModulesClassTemplate</td></tr><tr><td>returnTypesTemplate</td></tr><tr><td>returnsTemplate</td></tr><tr><td>seeLinkTemplate</td></tr><tr><td>seeListEntryTemplate</td></tr><tr><td>seeListTemplate</td></tr><tr><td>signalsListEntryTemplate</td></tr><tr><td>signalsListTemplate</td></tr><tr><td>sinceInfoTemplate</td></tr> +<tr><td>authorInfoTemplate</td></tr><tr><td>classTemplate</td></tr><tr><td>constructorTemplate</td></tr><tr><td>deprecatedTemplate</td></tr><tr><td>eventsListEntryTemplate</td></tr><tr><td>eventsListTemplate</td></tr><tr><td>exceptionsListEntryTemplate</td></tr><tr><td>exceptionsListTemplate</td></tr><tr><td>footerTemplate</td></tr><tr><td>functionTemplate</td></tr><tr><td>headerTemplate</td></tr><tr><td>indexBodyTemplate</td></tr><tr><td>indexListEntryTemplate</td></tr><tr><td>indexListModulesTemplate</td></tr><tr><td>indexListPackagesTemplate</td></tr><tr><td>listEntryDeprecatedTemplate</td></tr><tr><td>listEntryNoneTemplate</td></tr><tr><td>listEntrySimpleTemplate</td></tr><tr><td>listEntryTemplate</td></tr><tr><td>listTemplate</td></tr><tr><td>methodTemplate</td></tr><tr><td>moduleTemplate</td></tr><tr><td>paragraphTemplate</td></tr><tr><td>parameterTypesListEntryTemplate</td></tr><tr><td>parametersListEntryTemplate</td></tr><tr><td>parametersListTemplate</td></tr><tr><td>rbFileTemplate</td></tr><tr><td>rbModuleTemplate</td></tr><tr><td>rbModulesClassTemplate</td></tr><tr><td>returnTypesTemplate</td></tr><tr><td>returnsTemplate</td></tr><tr><td>seeLinkTemplate</td></tr><tr><td>seeListEntryTemplate</td></tr><tr><td>seeListTemplate</td></tr><tr><td>signalsListEntryTemplate</td></tr><tr><td>signalsListTemplate</td></tr><tr><td>sinceInfoTemplate</td></tr><tr><td>yieldTypesTemplate</td></tr><tr><td>yieldsTemplate</td></tr> </table> <h3>Classes</h3>
--- a/eric6/Documentation/Source/eric6.E5Graphics.E5ArrowItem.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.E5Graphics.E5ArrowItem.html Sat Jan 16 16:51:23 2021 +0100 @@ -141,7 +141,7 @@ Public method to return the bounding rectangle. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> bounding rectangle (QRectF) </dd>
--- a/eric6/Documentation/Source/eric6.E5Graphics.E5GraphicsView.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.E5Graphics.E5GraphicsView.html Sat Jan 16 16:51:23 2021 +0100 @@ -201,7 +201,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> diagram pixmap to receive the diagram (QPixmap) </dd> @@ -221,7 +221,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> index of zoom factor (integer) </dd> @@ -242,7 +242,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the minimum rectangle (QRectF) </dd> @@ -262,7 +262,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the minimum size (QSizeF) </dd> @@ -298,7 +298,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of interesting collision items (QGraphicsItem) </dd> @@ -311,7 +311,7 @@ Public method to get the configured background color. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> background color </dd> @@ -330,7 +330,7 @@ Public method to get the configured drawing colors. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> tuple containing the foreground and background colors </dd> @@ -349,7 +349,7 @@ Public method to get the configured foreground color. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> foreground color </dd> @@ -416,7 +416,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating success (boolean) </dd> @@ -461,7 +461,7 @@ Public method to get the current zoom factor in percent. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> current zoom factor in percent (integer) </dd>
--- a/eric6/Documentation/Source/eric6.E5Gui.E5Action.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.E5Gui.E5Action.html Sat Jan 16 16:51:23 2021 +0100 @@ -126,7 +126,7 @@ Special method returning a representation of the exception. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> string representing the error message </dd> @@ -139,7 +139,7 @@ Special method returning a string representation of the exception. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> string representing the error message </dd> @@ -256,7 +256,7 @@ Public method to retrieve the alternative keyboard shortcut. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> the alternative accelerator (QKeySequence) </dd> @@ -372,7 +372,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the created action group (QActionGroup) </dd>
--- a/eric6/Documentation/Source/eric6.E5Gui.E5AnimatedLabel.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.E5Gui.E5AnimatedLabel.html Sat Jan 16 16:51:23 2021 +0100 @@ -178,7 +178,7 @@ Public method to get the name of the animation file. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> path to the file containing the animation data </dd> @@ -197,7 +197,7 @@ Public method to get the interval between the animated frames. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> interval in milliseconds between animation frames </dd> @@ -216,7 +216,7 @@ Public method to check, if the animation is active. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating an active animation </dd> @@ -235,7 +235,7 @@ Public method to check, if the animation file was loaded. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating a successfully loaded animation file </dd>
--- a/eric6/Documentation/Source/eric6.E5Gui.E5AnimatedWidget.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.E5Gui.E5AnimatedWidget.html Sat Jan 16 16:51:23 2021 +0100 @@ -171,7 +171,7 @@ Public method to get a reference to the animated widget. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the animated widget </dd>
--- a/eric6/Documentation/Source/eric6.E5Gui.E5Application.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.E5Gui.E5Application.html Sat Jan 16 16:51:23 2021 +0100 @@ -140,7 +140,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the registered object </dd> @@ -173,7 +173,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the registered plugin object </dd> @@ -206,7 +206,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> type of the plugin object </dd> @@ -233,7 +233,7 @@ registered plugin objects. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of (name, reference) pairs </dd> @@ -321,7 +321,7 @@ background. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating the use of a palette with a dark background </dd>
--- a/eric6/Documentation/Source/eric6.E5Gui.E5ComboBox.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.E5Gui.E5ComboBox.html Sat Jan 16 16:51:23 2021 +0100 @@ -171,7 +171,7 @@ Public method to get the inactive text. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> inactive text (string) </dd>
--- a/eric6/Documentation/Source/eric6.E5Gui.E5Completers.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.E5Gui.E5Completers.html Sat Jan 16 16:51:23 2021 +0100 @@ -127,7 +127,7 @@ Public method to get the root path of the model. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> root path of the model </dd> @@ -228,7 +228,7 @@ Public method to get the root path of the model. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> root path of the model </dd>
--- a/eric6/Documentation/Source/eric6.E5Gui.E5ErrorMessage.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.E5Gui.E5ErrorMessage.html Sat Jan 16 16:51:23 2021 +0100 @@ -174,7 +174,7 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating that the message should be filtered out </dd> @@ -221,7 +221,7 @@ Module function to check, if a message handler was installed. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating an installed message handler </dd> @@ -244,7 +244,7 @@ message handler. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> reference to the message handler dialog </dd>
--- a/eric6/Documentation/Source/eric6.E5Gui.E5ErrorMessageFilterDialog.html Sat Jan 16 16:50:00 2021 +0100 +++ b/eric6/Documentation/Source/eric6.E5Gui.E5ErrorMessageFilterDialog.html Sat Jan 16 16:51:23 2021 +0100 @@ -124,7 +124,7 @@ Public method to get the list of message filters. </p> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> error message filters (list of strings) </dd>