Fixed a few source docu issues (forgotten signals and exceptions).

Fri, 05 May 2017 19:06:52 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 05 May 2017 19:06:52 +0200
changeset 5726
e1dbd217214a
parent 5725
671561c52802
child 5727
c8842a8d1167

Fixed a few source docu issues (forgotten signals and exceptions).

Cooperation/Connection.py file | annotate | diff | comparison | revisions
Debugger/BreakPointModel.py file | annotate | diff | comparison | revisions
Debugger/WatchPointModel.py file | annotate | diff | comparison | revisions
E5Gui/E5LineEdit.py file | annotate | diff | comparison | revisions
E5Gui/E5PassivePopup.py file | annotate | diff | comparison | revisions
E5Gui/E5PathPicker.py file | annotate | diff | comparison | revisions
E5Gui/E5ZoomWidget.py file | annotate | diff | comparison | revisions
E5Network/E5Ftp.py file | annotate | diff | comparison | revisions
Helpviewer/AdBlock/AdBlockManager.py file | annotate | diff | comparison | revisions
Helpviewer/GreaseMonkey/GreaseMonkeyConfiguration/GreaseMonkeyConfigurationListWidget.py file | annotate | diff | comparison | revisions
Helpviewer/GreaseMonkey/GreaseMonkeyDownloader.py file | annotate | diff | comparison | revisions
Helpviewer/GreaseMonkey/GreaseMonkeyManager.py file | annotate | diff | comparison | revisions
Helpviewer/HelpWindow.py file | annotate | diff | comparison | revisions
Helpviewer/Network/FollowRedirectReply.py file | annotate | diff | comparison | revisions
Helpviewer/UrlBar/SslLabel.py file | annotate | diff | comparison | revisions
Helpviewer/ZoomManager/ZoomManager.py file | annotate | diff | comparison | revisions
PluginManager/PluginManager.py file | annotate | diff | comparison | revisions
PluginManager/PluginUninstallDialog.py file | annotate | diff | comparison | revisions
Project/ProjectFormsBrowser.py file | annotate | diff | comparison | revisions
Project/ProjectInterfacesBrowser.py file | annotate | diff | comparison | revisions
Project/ProjectOthersBrowser.py file | annotate | diff | comparison | revisions
Project/ProjectResourcesBrowser.py file | annotate | diff | comparison | revisions
Project/ProjectSourcesBrowser.py file | annotate | diff | comparison | revisions
Project/ProjectTranslationsBrowser.py file | annotate | diff | comparison | revisions
Tools/TRPreviewer.py file | annotate | diff | comparison | revisions
UI/Browser.py file | annotate | diff | comparison | revisions
Utilities/BackgroundService.py file | annotate | diff | comparison | revisions
Utilities/__init__.py file | annotate | diff | comparison | revisions
Utilities/binplistlib.py file | annotate | diff | comparison | revisions
ViewManager/ViewManager.py file | annotate | diff | comparison | revisions
WebBrowser/AdBlock/AdBlockManager.py file | annotate | diff | comparison | revisions
WebBrowser/GreaseMonkey/GreaseMonkeyConfiguration/GreaseMonkeyConfigurationListWidget.py file | annotate | diff | comparison | revisions
WebBrowser/GreaseMonkey/GreaseMonkeyDownloader.py file | annotate | diff | comparison | revisions
WebBrowser/GreaseMonkey/GreaseMonkeyManager.py file | annotate | diff | comparison | revisions
WebBrowser/GreaseMonkey/GreaseMonkeyScript.py file | annotate | diff | comparison | revisions
WebBrowser/SpeedDial/SpeedDial.py file | annotate | diff | comparison | revisions
WebBrowser/Tools/WebIconProvider.py file | annotate | diff | comparison | revisions
WebBrowser/ZoomManager/ZoomManager.py file | annotate | diff | comparison | revisions
--- a/Cooperation/Connection.py	Fri May 05 19:05:26 2017 +0200
+++ b/Cooperation/Connection.py	Fri May 05 19:06:52 2017 +0200
@@ -39,6 +39,10 @@
         arrived
     @signal participants(participants) emitted after the list of participants
         has arrived (list of strings of "host:port")
+    @signal editorCommand(hash, fn, message) emitted after an editor command
+        has arrived (string, string, string)
+    @signal rejected(message) emitted after a connection has been rejected
+        (string)
     """
     WaitingForGreeting = 0
     ReadingGreeting = 1
--- a/Debugger/BreakPointModel.py	Fri May 05 19:05:26 2017 +0200
+++ b/Debugger/BreakPointModel.py	Fri May 05 19:06:52 2017 +0200
@@ -15,6 +15,9 @@
 class BreakPointModel(QAbstractItemModel):
     """
     Class implementing a custom model for breakpoints.
+    
+    @signal dataAboutToBeChanged(QModelIndex, QModelIndex) emitted to indicate
+        a change of the data
     """
     dataAboutToBeChanged = pyqtSignal(QModelIndex, QModelIndex)
     
--- a/Debugger/WatchPointModel.py	Fri May 05 19:05:26 2017 +0200
+++ b/Debugger/WatchPointModel.py	Fri May 05 19:06:52 2017 +0200
@@ -15,6 +15,9 @@
 class WatchPointModel(QAbstractItemModel):
     """
     Class implementing a custom model for watch expressions.
+    
+    @signal dataAboutToBeChanged(QModelIndex, QModelIndex) emitted to indicate
+        a change of the data
     """
     dataAboutToBeChanged = pyqtSignal(QModelIndex, QModelIndex)
     
--- a/E5Gui/E5LineEdit.py	Fri May 05 19:05:26 2017 +0200
+++ b/E5Gui/E5LineEdit.py	Fri May 05 19:06:52 2017 +0200
@@ -24,6 +24,8 @@
 class E5LineEditSideWidget(QWidget):
     """
     Class implementing the side widgets for the line edit class.
+    
+    @signal sizeHintChanged() emitted to indicate a change of the size hint
     """
     sizeHintChanged = pyqtSignal()
     
--- a/E5Gui/E5PassivePopup.py	Fri May 05 19:05:26 2017 +0200
+++ b/E5Gui/E5PassivePopup.py	Fri May 05 19:06:52 2017 +0200
@@ -18,6 +18,8 @@
     """
     Class implementing dialog-like popup that displays messages without
     interrupting the user.
+    
+    @signal clicked emitted to indicate a mouse button click
     """
     Boxed = 0
     Custom = 128
--- a/E5Gui/E5PathPicker.py	Fri May 05 19:05:26 2017 +0200
+++ b/E5Gui/E5PathPicker.py	Fri May 05 19:06:52 2017 +0200
@@ -679,13 +679,6 @@
     """
     Class implementing a path picker widget consisting of a line edit and a
     tool button to open a file dialog.
-    
-    @signal textChanged(path) emitted when the entered path has changed
-    @signal pathSelected(path) emitted after a path has been selected via the
-        file dialog
-    @signal aboutToShowPathPickerDialog emitted before the file dialog is shown
-    @signal pickerButtonClicked emitted when the picker button was pressed and
-        the widget mode is custom
     """
     def __init__(self, parent=None):
         """
@@ -701,13 +694,6 @@
     """
     Class implementing a path picker widget consisting of a combobox and a
     tool button to open a file dialog.
-    
-    @signal editTextChanged(path) emitted when the entered path has changed
-    @signal pathSelected(path) emitted after a path has been selected via the
-        file dialog
-    @signal aboutToShowPathPickerDialog emitted before the file dialog is shown
-    @signal pickerButtonClicked emitted when the picker button was pressed and
-        the widget mode is custom
     """
     def __init__(self, parent=None):
         """
--- a/E5Gui/E5ZoomWidget.py	Fri May 05 19:05:26 2017 +0200
+++ b/E5Gui/E5ZoomWidget.py	Fri May 05 19:06:52 2017 +0200
@@ -18,6 +18,8 @@
 class E5ZoomWidget(QWidget, Ui_E5ZoomWidget):
     """
     Class implementing a zoom widget for the status bar.
+    
+    @signal valueChanged(value) emitted to indicate the new zoom value (int)
     """
     valueChanged = pyqtSignal(int)
     
--- a/E5Network/E5Ftp.py	Fri May 05 19:05:26 2017 +0200
+++ b/E5Network/E5Ftp.py	Fri May 05 19:06:52 2017 +0200
@@ -252,6 +252,7 @@
         @param acct accounting information for the remote host (string)
         @return response sent by the remote host (string)
         @exception E5FtpProxyError raised to indicate a proxy related issue
+        @exception ftplib.error_reply raised to indicate an FTP error reply
         """
         if not user:
             user = "anonymous"
--- a/Helpviewer/AdBlock/AdBlockManager.py	Fri May 05 19:05:26 2017 +0200
+++ b/Helpviewer/AdBlock/AdBlockManager.py	Fri May 05 19:06:52 2017 +0200
@@ -25,6 +25,8 @@
     Class implementing the AdBlock manager.
     
     @signal rulesChanged() emitted after some rule has changed
+    @signal requiredSubscriptionLoaded(subscription) emitted to indicate
+        loading of a required subscription is finished (AdBlockSubscription)
     """
     rulesChanged = pyqtSignal()
     requiredSubscriptionLoaded = pyqtSignal(AdBlockSubscription)
--- a/Helpviewer/GreaseMonkey/GreaseMonkeyConfiguration/GreaseMonkeyConfigurationListWidget.py	Fri May 05 19:05:26 2017 +0200
+++ b/Helpviewer/GreaseMonkey/GreaseMonkeyConfiguration/GreaseMonkeyConfigurationListWidget.py	Fri May 05 19:06:52 2017 +0200
@@ -19,6 +19,9 @@
 class GreaseMonkeyConfigurationListWidget(QListWidget):
     """
     Class implementing a special list widget for GreaseMonkey scripts.
+    
+    @signal removeItemRequested(item) emitted to indicate an item removal
+        request (QListWidgetItem)
     """
     removeItemRequested = pyqtSignal(QListWidgetItem)
     
--- a/Helpviewer/GreaseMonkey/GreaseMonkeyDownloader.py	Fri May 05 19:05:26 2017 +0200
+++ b/Helpviewer/GreaseMonkey/GreaseMonkeyDownloader.py	Fri May 05 19:06:52 2017 +0200
@@ -24,6 +24,8 @@
 class GreaseMonkeyDownloader(QObject):
     """
     Class implementing the downloader for GreaseMonkey scripts.
+    
+    @signal finished() emitted to indicate the end of a script download
     """
     finished = pyqtSignal()
     
--- a/Helpviewer/GreaseMonkey/GreaseMonkeyManager.py	Fri May 05 19:05:26 2017 +0200
+++ b/Helpviewer/GreaseMonkey/GreaseMonkeyManager.py	Fri May 05 19:06:52 2017 +0200
@@ -22,6 +22,8 @@
 class GreaseMonkeyManager(QObject):
     """
     Class implementing the manager for GreaseMonkey scripts.
+    
+    @signal scriptsChanged() emitted to indicate a change of scripts
     """
     scriptsChanged = pyqtSignal()
     
--- a/Helpviewer/HelpWindow.py	Fri May 05 19:05:26 2017 +0200
+++ b/Helpviewer/HelpWindow.py	Fri May 05 19:06:52 2017 +0200
@@ -64,6 +64,7 @@
     @signal helpClosed() emitted after the window was requested to close down
     @signal zoomTextOnlyChanged(bool) emitted after the zoom text only setting
         was changed
+    @signal privacyChanged(bool) emitted to indicate a new privacy mode
     """
     zoomTextOnlyChanged = pyqtSignal(bool)
     helpClosed = pyqtSignal()
--- a/Helpviewer/Network/FollowRedirectReply.py	Fri May 05 19:05:26 2017 +0200
+++ b/Helpviewer/Network/FollowRedirectReply.py	Fri May 05 19:06:52 2017 +0200
@@ -16,6 +16,8 @@
 class FollowRedirectReply(QObject):
     """
     Class implementing a network reply delegate allowing to check redirects.
+    
+    @signal finished() emitted to indicate the end of the redirect
     """
     finished = pyqtSignal()
     
--- a/Helpviewer/UrlBar/SslLabel.py	Fri May 05 19:05:26 2017 +0200
+++ b/Helpviewer/UrlBar/SslLabel.py	Fri May 05 19:06:52 2017 +0200
@@ -16,6 +16,8 @@
 class SslLabel(QLabel):
     """
     Class implementing the label to show some SSL info.
+    
+    @signal clicked(pos) emitted to indicate a click of the label (QPoint)
     """
     clicked = pyqtSignal(QPoint)
     
--- a/Helpviewer/ZoomManager/ZoomManager.py	Fri May 05 19:05:26 2017 +0200
+++ b/Helpviewer/ZoomManager/ZoomManager.py	Fri May 05 19:06:52 2017 +0200
@@ -20,6 +20,8 @@
 class ZoomManager(QObject):
     """
     Class implementing a manager for site specific zoom level settings.
+    
+    @signal changed() emitted to indicate a change of the zoom level
     """
     changed = pyqtSignal()
     
--- a/PluginManager/PluginManager.py	Fri May 05 19:05:26 2017 +0200
+++ b/PluginManager/PluginManager.py	Fri May 05 19:06:52 2017 +0200
@@ -82,6 +82,8 @@
         @keyparam develPlugin filename of a plugin to be loaded for
             development (string)
         @exception PluginPathError raised to indicate an invalid plug-in path
+        @exception PluginModulesError raised to indicate the absence of
+            plug-in modules
         """
         super(PluginManager, self).__init__(parent)
         
@@ -337,6 +339,8 @@
         @param reload_ flag indicating to reload the module (boolean)
         @exception PluginLoadError raised to indicate an issue loading
             the plug-in
+        @exception PluginPy2IncompatibleError raised to indicate the Python 2
+            incompatibility of a plug-in
         """
         try:
             fname = "{0}.py".format(os.path.join(directory, name))
--- a/PluginManager/PluginUninstallDialog.py	Fri May 05 19:05:26 2017 +0200
+++ b/PluginManager/PluginUninstallDialog.py	Fri May 05 19:06:52 2017 +0200
@@ -31,6 +31,8 @@
 class PluginUninstallWidget(QWidget, Ui_PluginUninstallDialog):
     """
     Class implementing a dialog for plugin deinstallation.
+    
+    @signal accepted() emitted to indicate the removal of a plug-in
     """
     accepted = pyqtSignal()
     
--- a/Project/ProjectFormsBrowser.py	Fri May 05 19:05:26 2017 +0200
+++ b/Project/ProjectFormsBrowser.py	Fri May 05 19:06:52 2017 +0200
@@ -43,12 +43,7 @@
     
     @signal appendStderr(str) emitted after something was received from
         a QProcess on stderr
-    @signal sourceFile(str) emitted to open a forms file in an editor
     @signal uipreview(str) emitted to preview a forms file
-    @signal trpreview(list of str) emitted to preview form files in the
-        translations previewer
-    @signal closeSourceWindow(str) emitted after a file has been
-        removed/deleted from the project
     @signal showMenu(str, QMenu) emitted when a menu is about to be shown. The
         name of the menu and a reference to the menu are given.
     @signal menusAboutToBeCreated() emitted when the context menus are about to
--- a/Project/ProjectInterfacesBrowser.py	Fri May 05 19:05:26 2017 +0200
+++ b/Project/ProjectInterfacesBrowser.py	Fri May 05 19:06:52 2017 +0200
@@ -41,9 +41,6 @@
     """
     A class used to display the interfaces (IDL) part of the project.
     
-    @signal sourceFile(str, int = 0) emitted to open a file
-    @signal closeSourceWindow(str) emitted after a file has been
-        removed/deleted from the project
     @signal appendStdout(str) emitted after something was received from
         a QProcess on stdout
     @signal appendStderr(str) emitted after something was received from
--- a/Project/ProjectOthersBrowser.py	Fri May 05 19:05:26 2017 +0200
+++ b/Project/ProjectOthersBrowser.py	Fri May 05 19:06:52 2017 +0200
@@ -30,13 +30,6 @@
     A class used to display the parts of the project, that don't fit the
     other categories.
     
-    @signal sourceFile(str) emitted to open a file
-    @signal pixmapFile(str) emitted to open a pixmap file
-    @signal pixmapEditFile(str) emitted to edit a pixmap file
-    @signal svgFile(str) emitted to open a SVG file
-    @signal binaryFile(str) emitted to open a file as binary
-    @signal closeSourceWindow(str) emitted after a file has been
-        removed/deleted from the project
     @signal showMenu(str, QMenu) emitted when a menu is about to be shown.
         The name of the menu and a reference to the menu are given.
     """
--- a/Project/ProjectResourcesBrowser.py	Fri May 05 19:05:26 2017 +0200
+++ b/Project/ProjectResourcesBrowser.py	Fri May 05 19:06:52 2017 +0200
@@ -39,9 +39,6 @@
     
     @signal appendStderr(str) emitted after something was received from
         a QProcess on stderr
-    @signal sourceFile(str) emitted to open a resources file in an editor
-    @signal closeSourceWindow(str) emitted after a file has been
-        removed/deleted from the project
     @signal showMenu(str, QMenu) emitted when a menu is about to be shown.
         The name of the menu and a reference to the menu are given.
     """
--- a/Project/ProjectSourcesBrowser.py	Fri May 05 19:05:26 2017 +0200
+++ b/Project/ProjectSourcesBrowser.py	Fri May 05 19:06:52 2017 +0200
@@ -32,17 +32,8 @@
     """
     A class used to display the Sources part of the project.
     
-    @signal closeSourceWindow(str) emitted after a file has been
-        removed/deleted from the project
     @signal showMenu(str, QMenu) emitted when a menu is about to be shown.
         The name of the menu and a reference to the menu are given.
-    @signal sourceFile(str) emitted to open the given file.
-    @signal sourceFile(str, int) emitted to open the given file at the given
-        line.
-    @signal sourceFile(str, int, str) emitted to open the given file as the
-        given type at the given line.
-    @signal sourceFile(str, list) emitted to open a Python file giving a list
-        of lines
     """
     showMenu = pyqtSignal(str, QMenu)
     
--- a/Project/ProjectTranslationsBrowser.py	Fri May 05 19:05:26 2017 +0200
+++ b/Project/ProjectTranslationsBrowser.py	Fri May 05 19:06:52 2017 +0200
@@ -39,17 +39,10 @@
     """
     A class used to display the translations part of the project.
     
-    @signal linguistFile(str) emitted to open a translation file with
-        Qt-Linguist
     @signal appendStdout(str) emitted after something was received from
         a QProcess on stdout
     @signal appendStderr(str) emitted after something was received from
         a QProcess on stderr
-    @signal sourceFile(str) emitted to open a translation file in an editor
-    @signal closeSourceWindow(str) emitted after a file has been
-        removed/deleted from the project
-    @signal trpreview(list of str, bool = False) emitted to preview
-        translations in the translations previewer
     @signal showMenu(str, QMenu) emitted when a menu is about to be shown.
         The name of the menu and a reference to the menu are given.
     """
--- a/Tools/TRPreviewer.py	Fri May 05 19:05:26 2017 +0200
+++ b/Tools/TRPreviewer.py	Fri May 05 19:06:52 2017 +0200
@@ -753,7 +753,8 @@
     """
     Specialized MDI area to show the loaded widgets.
     
-    @signal lastWidgetClosed() emitted after last widget was closed
+    @signal lastWidgetClosed() emitted after the last widget was closed
+    @signal rebuildWidgets() emitted to indicate a change of loaded widgets
     """
     lastWidgetClosed = pyqtSignal()
     rebuildWidgets = pyqtSignal()
--- a/UI/Browser.py	Fri May 05 19:05:26 2017 +0200
+++ b/UI/Browser.py	Fri May 05 19:06:52 2017 +0200
@@ -40,21 +40,30 @@
     is displayed by a right click the user can select various actions on
     the selected file.
     
-    @signal sourceFile(str, int = 0, str = "") emitted to open a Python file
-        at a line
-    @signal sourceFile(str, list) emitted to open a Python file giving a list
-        of lines
-    @signal designerFile(str) emitted to open a Qt-Designer file
-    @signal linguistFile(str) emitted to open a Qt-Linguist (*.ts) file
-    @signal trpreview(list of str, bool = False) emitted to preview a
-        Qt-Linguist (*.qm) file
-    @signal projectFile(str) emitted to open an eric4/5 project file
-    @signal multiProjectFile(str) emitted to open an eric4/5 multi project file
-    @signal pixmapFile(str) emitted to open a pixmap file
-    @signal pixmapEditFile(str) emitted to edit a pixmap file
-    @signal svgFile(str) emitted to open a SVG file
-    @signal binaryFile(str) emitted to open a file as binary
-    @signal unittestOpen(str) emitted to open a Python file for a unittest
+    @signal sourceFile(filename) emitted to open a Python file at a line (str)
+    @signal sourceFile(filename, lineno) emitted to open a Python file at a
+        line (str, int)
+    @signal sourceFile(filename, lineno, type) emitted to open a Python file
+        at a line giving an explicit file type (str, int, str)
+    @signal sourceFile(filename, linenos) emitted to open a Python file giving
+        a list of lines(str, list)
+    @signal designerFile(filename) emitted to open a Qt-Designer file (str)
+    @signal linguistFile(filename) emitted to open a Qt-Linguist (*.ts)
+        file (str)
+    @signal trpreview(filenames) emitted to preview Qt-Linguist (*.qm)
+        files (list of str)
+    @signal trpreview(filenames, ignore) emitted to preview Qt-Linguist (*.qm)
+        files indicating whether non-existent files shall be ignored
+        (list of str, bool)
+    @signal projectFile(filename) emitted to open an eric project file (str)
+    @signal multiProjectFile(filename) emitted to open an eric multi project
+        file (str)
+    @signal pixmapFile(filename) emitted to open a pixmap file (str)
+    @signal pixmapEditFile(filename) emitted to edit a pixmap file (str)
+    @signal svgFile(filename) emitted to open a SVG file (str)
+    @signal binaryFile(filename) emitted to open a file as binary (str)
+    @signal unittestOpen(filename) emitted to open a Python file for a
+        unit test (str)
     """
     sourceFile = pyqtSignal((str, ), (str, int), (str, list), (str, int, str))
     designerFile = pyqtSignal(str)
--- a/Utilities/BackgroundService.py	Fri May 05 19:05:26 2017 +0200
+++ b/Utilities/BackgroundService.py	Fri May 05 19:06:52 2017 +0200
@@ -32,6 +32,12 @@
 class BackgroundService(QTcpServer):
     """
     Class implementing the main part of the background service.
+    
+    @signal serviceNotAvailable(function, language, filename, message)
+        emitted to indicate the non-availability of a service function
+        (str, str, str, str)
+    @signal batchJobDone(function, language) emitted to indicate the end of
+        a batch job (str, str)
     """
     serviceNotAvailable = pyqtSignal(str, str, str, str)
     batchJobDone = pyqtSignal(str, str)
--- a/Utilities/__init__.py	Fri May 05 19:05:26 2017 +0200
+++ b/Utilities/__init__.py	Fri May 05 19:06:52 2017 +0200
@@ -45,7 +45,7 @@
     @param file file to write the warning message to (ignored)
     @param line line causing the warning (ignored)
     @raise SyntaxError
-    """
+    """     # __IGNORE_WARNING_D252__ __IGNORE_WARNING_D253__
     if category is SyntaxWarning:
         err = SyntaxError(str(message))
         err.filename = filename
--- a/Utilities/binplistlib.py	Fri May 05 19:05:26 2017 +0200
+++ b/Utilities/binplistlib.py	Fri May 05 19:06:52 2017 +0200
@@ -292,6 +292,8 @@
         @return unpickled object
         @exception InvalidPlistException raised to indicate an invalid
             plist file
+        @exception NotBinaryPlistException raised to indicate, that the
+            plist file is not a binary file
         """
         result = None
         self.reset()
--- a/ViewManager/ViewManager.py	Fri May 05 19:05:26 2017 +0200
+++ b/ViewManager/ViewManager.py	Fri May 05 19:06:52 2017 +0200
@@ -40,7 +40,6 @@
     Class implementing a line edit that reacts to newline and cancel commands.
     
     @signal escPressed() emitted after the cancel command was activated
-    @signal returnPressed() emitted after a newline command was activated
     @signal gotFocus() emitted when the focus is changed to this widget
     """
     escPressed = pyqtSignal()
--- a/WebBrowser/AdBlock/AdBlockManager.py	Fri May 05 19:05:26 2017 +0200
+++ b/WebBrowser/AdBlock/AdBlockManager.py	Fri May 05 19:06:52 2017 +0200
@@ -30,6 +30,8 @@
     Class implementing the AdBlock manager.
     
     @signal rulesChanged() emitted after some rule has changed
+    @signal requiredSubscriptionLoaded(subscription) emitted to indicate
+        loading of a required subscription is finished (AdBlockSubscription)
     """
     rulesChanged = pyqtSignal()
     requiredSubscriptionLoaded = pyqtSignal(AdBlockSubscription)
--- a/WebBrowser/GreaseMonkey/GreaseMonkeyConfiguration/GreaseMonkeyConfigurationListWidget.py	Fri May 05 19:05:26 2017 +0200
+++ b/WebBrowser/GreaseMonkey/GreaseMonkeyConfiguration/GreaseMonkeyConfigurationListWidget.py	Fri May 05 19:06:52 2017 +0200
@@ -19,6 +19,9 @@
 class GreaseMonkeyConfigurationListWidget(QListWidget):
     """
     Class implementing a special list widget for GreaseMonkey scripts.
+    
+    @signal removeItemRequested(item) emitted to indicate an item removal
+        request (QListWidgetItem)
     """
     removeItemRequested = pyqtSignal(QListWidgetItem)
     
--- a/WebBrowser/GreaseMonkey/GreaseMonkeyDownloader.py	Fri May 05 19:05:26 2017 +0200
+++ b/WebBrowser/GreaseMonkey/GreaseMonkeyDownloader.py	Fri May 05 19:06:52 2017 +0200
@@ -17,10 +17,13 @@
 from WebBrowser.WebBrowserWindow import WebBrowserWindow
 
 
-# TODO: document signals
 class GreaseMonkeyDownloader(QObject):
     """
     Class implementing the downloader for GreaseMonkey scripts.
+    
+    @signal finished(fileName) emitted to indicate the end of a script download
+        (str)
+    @signal error() emitted to indicate a script download error
     """
     finished = pyqtSignal(str)
     error = pyqtSignal()
--- a/WebBrowser/GreaseMonkey/GreaseMonkeyManager.py	Fri May 05 19:05:26 2017 +0200
+++ b/WebBrowser/GreaseMonkey/GreaseMonkeyManager.py	Fri May 05 19:06:52 2017 +0200
@@ -26,6 +26,8 @@
 class GreaseMonkeyManager(QObject):
     """
     Class implementing the manager for GreaseMonkey scripts.
+    
+    @signal scriptsChanged() emitted to indicate a change of scripts
     """
     scriptsChanged = pyqtSignal()
     
--- a/WebBrowser/GreaseMonkey/GreaseMonkeyScript.py	Fri May 05 19:05:26 2017 +0200
+++ b/WebBrowser/GreaseMonkey/GreaseMonkeyScript.py	Fri May 05 19:06:52 2017 +0200
@@ -23,6 +23,10 @@
 class GreaseMonkeyScript(QObject):
     """
     Class implementing the GreaseMonkey script.
+    
+    @signal scriptChanged() emitted to indicate a script change
+    @signal updatingChanged(bool) emitted to indicate a change of the
+        updating state
     """
     DocumentStart = 0
     DocumentEnd = 1
--- a/WebBrowser/SpeedDial/SpeedDial.py	Fri May 05 19:05:26 2017 +0200
+++ b/WebBrowser/SpeedDial/SpeedDial.py	Fri May 05 19:06:52 2017 +0200
@@ -33,7 +33,7 @@
     
     @signal pagesChanged() emitted after the list of pages changed
     @signal thumbnailLoaded(url, src) emitted after a thumbnail was loaded
-    @signal titleLoaded(url, title) emitted after a title was loaded
+    @signal pageTitleLoaded(url, title) emitted after a title was loaded
     @signal speedDialSaved() emitted after the speed dial data was saved
     """
     pagesChanged = pyqtSignal()
--- a/WebBrowser/Tools/WebIconProvider.py	Fri May 05 19:05:26 2017 +0200
+++ b/WebBrowser/Tools/WebIconProvider.py	Fri May 05 19:06:52 2017 +0200
@@ -25,6 +25,8 @@
 class WebIconProvider(QObject):
     """
     Class implementing a web site icon storage.
+    
+    @signal changed() emitted to indicate a change of the icons database
     """
     changed = pyqtSignal()
     
--- a/WebBrowser/ZoomManager/ZoomManager.py	Fri May 05 19:05:26 2017 +0200
+++ b/WebBrowser/ZoomManager/ZoomManager.py	Fri May 05 19:06:52 2017 +0200
@@ -20,6 +20,8 @@
 class ZoomManager(QObject):
     """
     Class implementing a manager for site specific zoom level settings.
+    
+    @signal changed() emitted to indicate a change of the zoom level
     """
     changed = pyqtSignal()
     

eric ide

mercurial