diff -r 19bbd56ac5f2 -r 48fbf9149d16 eric6/Documentation/Source/eric6.Utilities.BackgroundClient.html
--- a/eric6/Documentation/Source/eric6.Utilities.BackgroundClient.html Thu Jan 07 17:22:16 2021 +0100
+++ b/eric6/Documentation/Source/eric6.Utilities.BackgroundClient.html Thu Jan 07 18:11:11 2021 +0100
@@ -71,7 +71,7 @@
<tr>
<td><a href="#BackgroundClient.__init__">BackgroundClient</a></td>
-<td>Constructor of the BackgroundClient class.</td>
+<td>Constructor</td>
</tr>
<tr>
<td><a href="#BackgroundClient.__cancelled">__cancelled</a></td>
@@ -83,15 +83,15 @@
</tr>
<tr>
<td><a href="#BackgroundClient.__peek">__peek</a></td>
-<td>Private methode to peek the given length of bytes.</td>
+<td>Private method to peek the given length of bytes.</td>
</tr>
<tr>
<td><a href="#BackgroundClient.__receive">__receive</a></td>
-<td>Private methode to receive the given length of bytes.</td>
+<td>Private method to receive the given length of bytes.</td>
</tr>
<tr>
<td><a href="#BackgroundClient.__send">__send</a></td>
-<td>Private method to send a job response back to the BackgroundService.</td>
+<td>Private method to send a job response back to the BackgroundService server.</td>
</tr>
<tr>
<td><a href="#BackgroundClient.run">run</a></td>
@@ -109,7 +109,7 @@
<b>BackgroundClient</b>(<i>host, port, maxProcs</i>)
<p>
- Constructor of the BackgroundClient class.
+ Constructor
</p>
<dl>
@@ -137,7 +137,13 @@
<dl>
<dt>Returns:</dt>
<dd>
-flag indicating a cancellation (boolean)
+flag indicating a cancellation
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="BackgroundClient.__initClientService" ID="BackgroundClient.__initClientService"></a>
@@ -149,23 +155,29 @@
</p>
<dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
<dd>
-service name to register (str)
+service name to register
</dd>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
<dd>
-contains the path to the module (str)
+contains the path to the module
</dd>
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
<dd>
-name to import (str)
+name to import
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
-text result of the import action (str)
+text result of the import action
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="BackgroundClient.__peek" ID="BackgroundClient.__peek"></a>
@@ -173,19 +185,25 @@
<b>__peek</b>(<i>length</i>)
<p>
- Private methode to peek the given length of bytes.
+ Private method to peek the given length of bytes.
</p>
<dl>
-<dt><i>length</i></dt>
+<dt><i>length</i> (int)</dt>
<dd>
-bytes to receive (int)
+bytes to receive
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
-received bytes (bytes)
+received bytes
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytes
</dd>
</dl>
<a NAME="BackgroundClient.__receive" ID="BackgroundClient.__receive"></a>
@@ -193,19 +211,25 @@
<b>__receive</b>(<i>length</i>)
<p>
- Private methode to receive the given length of bytes.
+ Private method to receive the given length of bytes.
</p>
<dl>
-<dt><i>length</i></dt>
+<dt><i>length</i> (int)</dt>
<dd>
-bytes to receive (int)
+bytes to receive
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
-received bytes or None if connection closed (bytes)
+received bytes or None if connection closed
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytes
</dd>
</dl>
<a NAME="BackgroundClient.__send" ID="BackgroundClient.__send"></a>
@@ -213,21 +237,22 @@
<b>__send</b>(<i>fx, fn, data</i>)
<p>
- Private method to send a job response back to the BackgroundService.
+ Private method to send a job response back to the BackgroundService
+ server.
</p>
<dl>
-<dt><i>fx</i></dt>
+<dt><i>fx</i> (str)</dt>
<dd>
-remote function name to execute (str)
+remote function name to execute
</dd>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
<dd>
-filename for identification (str)
+filename for identification
</dd>
-<dt><i>data</i></dt>
+<dt><i>data</i> (any basic datatype)</dt>
<dd>
-return value(s) (any basic datatype)
+return value(s)
</dd>
</dl>
<a NAME="BackgroundClient.run" ID="BackgroundClient.run"></a>
