diff -r c712d09cc839 -r f6881d10e995 src/eric7/WebBrowser/Sync/SyncManager.py
--- a/src/eric7/WebBrowser/Sync/SyncManager.py Fri Dec 22 13:57:47 2023 +0100
+++ b/src/eric7/WebBrowser/Sync/SyncManager.py Fri Dec 22 17:24:07 2023 +0100
@@ -21,16 +21,11 @@
"""
Class implementing the synchronization manager.
- @signal syncError(message) emitted for a general error with the error
- message (string)
- @signal syncMessage(message) emitted to give status info about the sync
- process (string)
- @signal syncStatus(type_, message) emitted to indicate the synchronization
- status (string one of "bookmarks", "history", "passwords",
- "useragents" or "speeddial", string)
- @signal syncFinished(type_, done, download) emitted after a
- synchronization has finished (string one of "bookmarks", "history",
- "passwords", "useragents" or "speeddial", boolean, boolean)
+ @signal syncError(message) emitted for a general error with the error message
+ @signal syncMessage(message) emitted to give status info about the sync process
+ @signal syncStatus(type_, message) emitted to indicate the synchronization status
+ @signal syncFinished(type_, done, download) emitted after a synchronization
+ has finished
"""
syncError = pyqtSignal(str)
@@ -42,7 +37,8 @@
"""
Constructor
- @param parent reference to the parent object (QObject)
+ @param parent reference to the parent object
+ @type QObject
"""
super().__init__(parent)
@@ -52,7 +48,8 @@
"""
Public method to get a reference to the sync handler object.
- @return reference to the sync handler object (SyncHandler)
+ @return reference to the sync handler object
+ @rtype SyncHandler
"""
return self.__handler
@@ -70,7 +67,8 @@
Public method to load the settings.
@param forceUpload flag indicating a forced upload of the files
- (boolean)
+
+ @type bool
"""
if self.__handler is not None:
self.__handler.syncError.disconnect(self.__syncError)
@@ -202,6 +200,7 @@
Public method to check, if synchronization is enabled.
@return flag indicating enabled synchronization
+ @rtype bool
"""
from . import SyncGlobals
@@ -249,7 +248,8 @@
"""
Private slot to handle general synchronization issues.
- @param message error message (string)
+ @param message error message
+ @type str
"""
self.syncError.emit(message)
@@ -257,11 +257,13 @@
"""
Private slot to handle a finished synchronization event.
- @param type_ type of the synchronization event (string one
- of "bookmarks", "history", "passwords", "useragents" or
- "speeddial")
- @param status flag indicating success (boolean)
- @param download flag indicating a download of a file (boolean)
+ @param type_ type of the synchronization event (one of "bookmarks",
+ "history", "passwords", "useragents" or "speeddial")
+ @type str
+ @param status flag indicating success
+ @type bool
+ @param download flag indicating a download of a file
+ @type bool
"""
if status and download:
if type_ == "bookmarks":
@@ -280,10 +282,11 @@
"""
Private slot to handle a status update of a synchronization event.
- @param type_ type of the synchronization event (string one
- of "bookmarks", "history", "passwords", "useragents" or
- "speeddial")
- @param message status message for the event (string)
+ @param type_ type of the synchronization event (one of "bookmarks",
+ "history", "passwords", "useragents" or "speeddial")
+ @type str
+ @param message status message for the event
+ @type str
"""
self.syncMessage.emit(message)
self.syncStatus.emit(type_, message)
