Mercurial Repositories > eric / file diff

--- a/src/eric7/WebBrowser/Sync/SyncHandler.py	Fri Dec 22 13:57:47 2023 +0100
+++ b/src/eric7/WebBrowser/Sync/SyncHandler.py	Fri Dec 22 17:24:07 2023 +0100
@@ -19,16 +19,11 @@
     """
     Base class for synchronization handlers.
 
-    @signal syncStatus(type_, message) emitted to indicate the synchronization
-        status (string one of "bookmarks", "history", "passwords",
-        "useragents" or "speeddial", string)
-    @signal syncError(message) emitted for a general error with the error
-        message (string)
-    @signal syncMessage(message) emitted to send a message about
-        synchronization (string)
-    @signal syncFinished(type_, done, download) emitted after a
-        synchronization has finished (string one of "bookmarks", "history",
-        "passwords", "useragents" or "speeddial", boolean, boolean)
+    @signal syncStatus(type_, message) emitted to indicate the synchronization status
+    @signal syncError(message) emitted for a general error with the error message
+    @signal syncMessage(message) emitted to send a message about synchronization
+    @signal syncFinished(type_, done, download) emitted after a synchronization
+        has finished
     """
 
     syncStatus = pyqtSignal(str, str)
@@ -40,7 +35,8 @@
         """
         Constructor
 
-        @param parent reference to the parent object (QObject)
+        @param parent reference to the parent object
+        @type QObject
         """
         super().__init__(parent)
 
@@ -188,7 +184,7 @@
         Public method to do the initial check.
 
         @param forceUpload flag indicating a forced upload of the files
-            (boolean)
+        @type bool
         @exception NotImplementedError raised to indicate that this method
             must be implemented by subclasses
         """
@@ -210,11 +206,13 @@
         If encrypted synchronization is enabled, the data will be encrypted
         using the relevant encryption key.
 
-        @param fileName name of the file to be read (string)
-        @param type_ type of the synchronization event (string one
-            of "bookmarks", "history", "passwords", "useragents" or
-            "speeddial")
-        @return data of the file, optionally encrypted (QByteArray)
+        @param fileName name of the file to be read
+        @type str
+        @param type_ type of the synchronization event (one of "bookmarks",
+            "history", "passwords", "useragents" or "speeddial")
+        @type str
+        @return data of the file, optionally encrypted
+        @rtype QByteArray
         """
         if os.path.exists(fileName):
             try:
@@ -254,14 +252,17 @@
         If encrypted synchronization is enabled, the data will be decrypted
         using the relevant encryption key.
 
-        @param data data to be written and optionally decrypted (QByteArray)
-        @param fileName name of the file the data is to be written to (string)
-        @param type_ type of the synchronization event (string one
-            of "bookmarks", "history", "passwords", "useragents" or
-            "speeddial")
-        @param timestamp timestamp to be given to the file (int)
-        @return tuple giving a success flag and an error string (boolean,
-            string)
+        @param data data to be written and optionally decrypted
+        @type QByteArray
+        @param fileName name of the file the data is to be written to
+        @type str
+        @param type_ type of the synchronization event (one of "bookmarks",
+            "history", "passwords", "useragents" or "speeddial")
+        @type str
+        @param timestamp timestamp to be given to the file
+        @type int
+        @return tuple giving a success flag and an error string
+        @rtype tuple of (bool, str)
         """
         data = bytes(data)