diff -r c4c17121eff8 -r a21d673a8f99 eric6/Documentation/Source/eric6.Project.Project.html
--- a/eric6/Documentation/Source/eric6.Project.Project.html Sat Jan 16 16:50:00 2021 +0100
+++ b/eric6/Documentation/Source/eric6.Project.Project.html Sat Jan 16 16:51:23 2021 +0100
@@ -1146,7 +1146,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
name of the binary translations file (string)
</dd>
@@ -1190,7 +1190,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating membership (boolean)
</dd>
@@ -1229,7 +1229,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
modified source (bytes), snapshot version string (string)
</dd>
@@ -1348,7 +1348,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating membership
</dd>
@@ -1472,7 +1472,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
version string (string)
</dd>
@@ -1493,7 +1493,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
version info as a tuple
</dd>
@@ -1534,7 +1534,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success
</dd>
@@ -1749,7 +1749,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
source extensions (list of string)
</dd>
@@ -1824,7 +1824,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success
</dd>
@@ -2055,7 +2055,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success (boolean)
</dd>
@@ -2068,7 +2068,7 @@
Public method to check dirty status and open a message window.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating whether this operation was successful (boolean)
</dd>
@@ -2134,7 +2134,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success (boolean)
</dd>
@@ -2193,7 +2193,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success (boolean)
</dd>
@@ -2213,7 +2213,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success (boolean)
</dd>
@@ -2256,7 +2256,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
absolute path (string)
</dd>
@@ -2277,7 +2277,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
absolute path (string)
</dd>
@@ -2290,7 +2290,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>
@@ -2316,7 +2316,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
a copy of the requested data or None
</dd>
@@ -2336,7 +2336,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
value of the property
</dd>
@@ -2356,7 +2356,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
filter string
</dd>
@@ -2375,7 +2375,7 @@
Public method to get the default rcc compiler parameters.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
dictionary containing the default rcc compiler parameters
</dd>
@@ -2395,7 +2395,7 @@
programming language.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
default extension (including the dot) (string)
</dd>
@@ -2416,7 +2416,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
the requested lexer language (string)
</dd>
@@ -2429,7 +2429,7 @@
Public method to get the EOL-string to be used by the project.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
eol string (string)
</dd>
@@ -2449,7 +2449,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of files starting with a common prefix (list of strings)
</dd>
@@ -2462,7 +2462,7 @@
Public method to get the project hash.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
project hash as a hex string (string)
</dd>
@@ -2483,7 +2483,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
filename of the projects main script (string)
</dd>
@@ -2503,7 +2503,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the requested menu (QMenu) or None
</dd>
@@ -2516,7 +2516,7 @@
Public method to get a reference to the project browser model.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the project browser model (ProjectBrowserModel)
</dd>
@@ -2529,7 +2529,7 @@
Public method to get the most recently opened project.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
path of the most recently opened project (string)
</dd>
@@ -2542,7 +2542,7 @@
Public method to get the programming languages supported by project.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of supported programming languages (list of string)
</dd>
@@ -2555,7 +2555,7 @@
Public method to get the author of the project.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
author name
</dd>
@@ -2574,7 +2574,7 @@
Public method to get the email address of the project author.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
project author email
</dd>
@@ -2593,7 +2593,7 @@
Public method to get the description of the project.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
project description
</dd>
@@ -2612,7 +2612,7 @@
Public method to get the names of the project specific dictionaries.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
tuple of two strings giving the absolute path names of the
project specific word and exclude list
@@ -2626,7 +2626,7 @@
Public method to get the path of the project file.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
path of the project file (string)
</dd>
@@ -2651,7 +2651,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of file names
</dd>
@@ -2677,7 +2677,7 @@
Public method to get the project's programming language.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
programming language (string)
</dd>
@@ -2690,7 +2690,7 @@
Public method to get the path of the management directory.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
path of the management directory (string)
</dd>
@@ -2706,7 +2706,7 @@
The project name is determined from the name of the project file.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
name of the project (string)
</dd>
@@ -2719,7 +2719,7 @@
Public method to get the project path.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
project path (string)
</dd>
@@ -2732,7 +2732,7 @@
Public method to get the project's programming language.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
programming language (string)
</dd>
@@ -2745,7 +2745,7 @@
Public method to get the type of the project.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
UI type of the project (string)
</dd>
@@ -2766,7 +2766,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the dictionary of project types.
</dd>
@@ -2779,7 +2779,7 @@
Public mehod to get the version number of the project.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
version number
</dd>
@@ -2806,7 +2806,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
project relative path or unchanged path, if path doesn't
belong to the project (string)
@@ -2828,7 +2828,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
project relative path or unchanged path, if path doesn't
belong to the project (string)
@@ -2850,7 +2850,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
list of the projects scripts (list of string)
</dd>
@@ -2863,7 +2863,7 @@
Public method to retrieve the status of the auto update function.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
status of the auto update function (boolean)
</dd>
@@ -2876,7 +2876,7 @@
Public method to get the monitor interval.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
interval in seconds (integer)
</dd>
@@ -2889,7 +2889,7 @@
Public method to get the translation pattern.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
translation pattern (string)
</dd>
@@ -2909,7 +2909,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
value of the given parameter
</dd>
@@ -2928,7 +2928,7 @@
Public method to get a reference to the VCS object.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
reference to the VCS object
</dd>
@@ -2956,7 +2956,7 @@
parameters.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating default parameter set
</dd>
@@ -2976,7 +2976,7 @@
parameters.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating default parameter set
</dd>
@@ -2996,7 +2996,7 @@
parameters.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating default parameter set
</dd>
@@ -3016,7 +3016,7 @@
parameters.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating default parameter set
</dd>
@@ -3042,7 +3042,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating, if the project contains the file (boolean)
</dd>
@@ -3066,7 +3066,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating presence of the project type (boolean)
</dd>
@@ -3094,7 +3094,7 @@
Public slot to initialize the project menus.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
tuple of generated menus
</dd>
@@ -3122,7 +3122,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
tuple of the generated toolbars (tuple of two QToolBar)
</dd>
@@ -3147,7 +3147,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
a reference to the vcs object
</dd>
@@ -3160,7 +3160,7 @@
Public method to return the status of the debug properties.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
load status of debug properties (boolean)
</dd>
@@ -3173,7 +3173,7 @@
Public method to return the dirty state.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
dirty state (boolean)
</dd>
@@ -3186,7 +3186,7 @@
Public method to check, if this project is a JavaScript project.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating a JavaScript project (boolean)
</dd>
@@ -3199,7 +3199,7 @@
Public method to test, if make is enabled for the project.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating enabled make support
</dd>
@@ -3218,7 +3218,7 @@
Public method to check, if this project is a MicroPython project.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating a MicroPython project
</dd>
@@ -3237,7 +3237,7 @@
Public method to check, if this is a mixed language project.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating a mixed language project
</dd>
@@ -3256,7 +3256,7 @@
Public method to return the opened state.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
open state (boolean)
</dd>
@@ -3277,7 +3277,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating membership (boolean)
</dd>
@@ -3298,7 +3298,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating membership (boolean)
</dd>
@@ -3319,7 +3319,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating membership (boolean)
</dd>
@@ -3340,7 +3340,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating membership
</dd>
@@ -3367,7 +3367,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating membership (boolean)
</dd>
@@ -3388,7 +3388,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating membership (boolean)
</dd>
@@ -3401,7 +3401,7 @@
Public method to check, if this project is a Python3 project.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating a Python3 project (boolean)
</dd>
@@ -3415,7 +3415,7 @@
project.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating a Python project (boolean)
</dd>
@@ -3428,7 +3428,7 @@
Public method to check, if this project is a Ruby project.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating a Ruby project (boolean)
</dd>
@@ -3637,7 +3637,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success
</dd>
@@ -3727,7 +3727,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success (boolean)
</dd>
@@ -3740,7 +3740,7 @@
Public slot to save the current project.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success
</dd>
@@ -3753,7 +3753,7 @@
Public slot to save the current project to a different file.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success (boolean)
</dd>
@@ -3783,7 +3783,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating success (boolean)
</dd>
@@ -3929,7 +3929,7 @@
</dd>
</dl>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating that the path starts with the project path
(boolean)
@@ -3979,7 +3979,7 @@
Public method to check, if the project uses the system eol setting.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating the usage of system eol (boolean)
</dd>
@@ -3993,7 +3993,7 @@
to the IDE.
</p>
<dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
<dd>
flag indicating availability of VCS software (boolean)
</dd>
