Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.WebBrowser.Sync.FtpSyncHandler.html	Fri Dec 22 13:57:47 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.WebBrowser.Sync.FtpSyncHandler.html	Fri Dec 22 17:24:07 2023 +0100
@@ -43,25 +43,20 @@
 
 <dt>syncError(message)</dt>
 <dd>
-emitted for a general error with the error
-        message (string)
+emitted for a general error with the error message
 </dd>
 <dt>syncFinished(type_, done, download)</dt>
 <dd>
-emitted after a
-        synchronization has finished (string one of "bookmarks", "history",
-        "passwords", "useragents" or "speeddial", boolean, boolean)
+emitted after a synchronization
+        has finished
 </dd>
 <dt>syncMessage(message)</dt>
 <dd>
-emitted to send a message about
-        synchronization (string)
+emitted to send a message about synchronization
 </dd>
 <dt>syncStatus(type_, message)</dt>
 <dd>
-emitted to indicate the synchronization
-        status (string one of "bookmarks", "history", "passwords",
-        "useragents" or "speeddial", string)
+emitted to indicate the synchronization status
 </dd>
 </dl>
 <h3>Derived from</h3>
@@ -172,9 +167,9 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QObject)</dt>
 <dd>
-reference to the parent object (QObject)
+reference to the parent object
 </dd>
 </dl>
 <a NAME="FtpSyncHandler.__changeToStore" ID="FtpSyncHandler.__changeToStore"></a>
@@ -199,7 +194,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating a successful log in (boolean)
+flag indicating a successful log in
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="FtpSyncHandler.__dirListCallback" ID="FtpSyncHandler.__dirListCallback"></a>
@@ -211,9 +212,9 @@
 </p>
 <dl>
 
-<dt><i>line</i></dt>
+<dt><i>line</i> (str)</dt>
 <dd>
-the received line of the directory listing (string)
+the received line of the directory listing
 </dd>
 </dl>
 <a NAME="FtpSyncHandler.__doFtpCommands" ID="FtpSyncHandler.__doFtpCommands"></a>
@@ -232,20 +233,18 @@
 </p>
 <dl>
 
-<dt><i>type_</i></dt>
+<dt><i>type_</i> (str)</dt>
 <dd>
-type of the synchronization event (string one
-            of "bookmarks", "history", "passwords", "useragents" or
-            "speeddial")
+type of the synchronization event (one of
+            "bookmarks", "history", "passwords", "useragents" or "speeddial")
 </dd>
-<dt><i>fileName</i></dt>
+<dt><i>fileName</i> (str)</dt>
 <dd>
-name of the file to be downloaded (string)
+name of the file to be downloaded
 </dd>
-<dt><i>timestamp</i></dt>
+<dt><i>timestamp</i> (int)</dt>
 <dd>
 time stamp in seconds of the file to be downloaded
-            (integer)
 </dd>
 </dl>
 <a NAME="FtpSyncHandler.__downloadFileCallback" ID="FtpSyncHandler.__downloadFileCallback"></a>
@@ -257,19 +256,25 @@
 </p>
 <dl>
 
-<dt><i>buffer</i></dt>
+<dt><i>buffer</i> (io.BytesIO)</dt>
 <dd>
-reference to the buffer (io.BytesIO)
+reference to the buffer
 </dd>
-<dt><i>data</i></dt>
+<dt><i>data</i> (bytes)</dt>
 <dd>
-byte string to store in the buffer (bytes)
+byte string to store in the buffer
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-number of bytes written to the buffer (integer)
+number of bytes written to the buffer
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <a NAME="FtpSyncHandler.__idleTimeout" ID="FtpSyncHandler.__idleTimeout"></a>
@@ -295,15 +300,14 @@
 </p>
 <dl>
 
-<dt><i>type_</i></dt>
+<dt><i>type_</i> (str)</dt>
 <dd>
-type of the synchronization event (string one
-            of "bookmarks", "history", "passwords", "useragents" or
-            "speeddial")
+type of the synchronization event (one of "bookmarks",
+            "history", "passwords", "useragents" or "speeddial")
 </dd>
-<dt><i>fileName</i></dt>
+<dt><i>fileName</i> (str)</dt>
 <dd>
-name of the file to be synchronized (string)
+name of the file to be synchronized
 </dd>
 </dl>
 <a NAME="FtpSyncHandler.__syncFile" ID="FtpSyncHandler.__syncFile"></a>
@@ -315,15 +319,14 @@
 </p>
 <dl>
 
-<dt><i>type_</i></dt>
+<dt><i>type_</i> (str)</dt>
 <dd>
-type of the synchronization event (string one
-            of "bookmarks", "history", "passwords", "useragents" or
-            "speeddial")
+type of the synchronization event (one of "bookmarks",
+            "history", "passwords", "useragents" or "speeddial")
 </dd>
-<dt><i>fileName</i></dt>
+<dt><i>fileName</i> (str)</dt>
 <dd>
-name of the file to be synchronized (string)
+name of the file to be synchronized
 </dd>
 </dl>
 <a NAME="FtpSyncHandler.__uploadFile" ID="FtpSyncHandler.__uploadFile"></a>
@@ -335,21 +338,26 @@
 </p>
 <dl>
 
-<dt><i>type_</i></dt>
+<dt><i>type_</i> (str)</dt>
 <dd>
-type of the synchronization event (string one
-            of "bookmarks", "history", "passwords", "useragents" or
-            "speeddial")
+type of the synchronization event (one of "bookmarks",
+            "history", "passwords", "useragents" or "speeddial")
 </dd>
-<dt><i>fileName</i></dt>
+<dt><i>fileName</i> (str)</dt>
 <dd>
-name of the file to be uploaded (string)
+name of the file to be uploaded
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="FtpSyncHandler.initialLoadAndCheck" ID="FtpSyncHandler.initialLoadAndCheck"></a>
@@ -361,10 +369,9 @@
 </p>
 <dl>
 
-<dt><i>forceUpload</i></dt>
+<dt><i>forceUpload</i> (bool)</dt>
 <dd>
 flag indicating a forced upload of the files
-            (boolean)
 </dd>
 </dl>
 <a NAME="FtpSyncHandler.shutdown" ID="FtpSyncHandler.shutdown"></a>