Continued correcting doc strings by using the new doc string checker.

Sun, 29 Sep 2013 15:54:10 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 29 Sep 2013 15:54:10 +0200
changeset 2964
84b65fb9e780
parent 2963
745d38097b7f
child 2965
d133c7edd88a

Continued correcting doc strings by using the new doc string checker.

Plugins/ViewManagerPlugins/Listspace/Listspace.py file | annotate | diff | comparison | revisions
Plugins/ViewManagerPlugins/Tabview/Tabview.py file | annotate | diff | comparison | revisions
Plugins/WizardPlugins/E5MessageBoxWizard/E5MessageBoxWizardDialog.py file | annotate | diff | comparison | revisions
Plugins/WizardPlugins/QRegularExpressionWizard/QRegularExpressionWizardDialog.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationDialog.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/ApplicationPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/ConfigurationPageBase.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/CooperationPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/CorbaPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/DebuggerGeneralPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/DebuggerPython3Page.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/DebuggerPythonPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/DebuggerRubyPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorAPIsPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorAutocompletionPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorAutocompletionQScintillaPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorCalltipsPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorCalltipsQScintillaPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorExportersPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorFilePage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorGeneralPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorHighlightersPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorHighlightingStylesPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorKeywordsPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorPropertiesPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorSearchPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorSpellCheckingPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorStylesPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorSyntaxPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EditorTypingPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/EmailPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/GraphicsPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/HelpAppearancePage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/HelpDocumentationPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/HelpInterfacePage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/HelpViewersPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/HelpVirusTotalPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/HelpWebBrowserPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/IconsPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/InterfacePage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/IrcPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/MasterPasswordEntryDialog.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/MultiProjectPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/NetworkPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/NotificationsPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/PluginManagerPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/PrinterPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/ProjectBrowserPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/ProjectPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/PythonPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/QtPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/SecurityPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/ShellPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/TasksPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/TemplatesPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/TrayStarterPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/VcsPage.py file | annotate | diff | comparison | revisions
Preferences/ConfigurationPages/ViewmanagerPage.py file | annotate | diff | comparison | revisions
Preferences/PreferencesLexer.py file | annotate | diff | comparison | revisions
Preferences/ViewProfileDialog.py file | annotate | diff | comparison | revisions
Preferences/__init__.py file | annotate | diff | comparison | revisions
Project/AddFoundFilesDialog.py file | annotate | diff | comparison | revisions
Project/NewPythonPackageDialog.py file | annotate | diff | comparison | revisions
Project/Project.py file | annotate | diff | comparison | revisions
--- a/Plugins/ViewManagerPlugins/Listspace/Listspace.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Plugins/ViewManagerPlugins/Listspace/Listspace.py	Sun Sep 29 15:54:10 2013 +0200
@@ -184,8 +184,6 @@
         Constructor
         
         @param parent parent widget (QWidget)
-        @param ui reference to the main user interface
-        @param dbs reference to the debug server object
         """
         self.stacks = []
         
@@ -250,7 +248,10 @@
         
     def __showMenu(self, point):
         """
-        Private slot to handle the customContextMenuRequested signal of the viewlist.
+        Private slot to handle the customContextMenuRequested signal of
+        the viewlist.
+        
+        @param point position to open the menu at (QPoint)
         """
         if self.editors:
             itm = self.viewlist.itemAt(point)
@@ -310,7 +311,7 @@
         
     def _removeAllViews(self):
         """
-        Protected method to remove all views (i.e. windows)
+        Protected method to remove all views (i.e. windows).
         """
         self.viewlist.clear()
         for win in self.editors:
@@ -322,7 +323,7 @@
         
     def _removeView(self, win):
         """
-        Protected method to remove a view (i.e. window)
+        Protected method to remove a view (i.e. window).
         
         @param win editor window to be removed
         """
@@ -359,7 +360,7 @@
         
     def _addView(self, win, fn=None, noName=""):
         """
-        Protected method to add a view (i.e. window)
+        Protected method to add a view (i.e. window).
         
         @param win editor assembly to be added
         @param fn filename of this editor (string)
@@ -422,7 +423,7 @@
         
     def _showView(self, win, fn=None):
         """
-        Protected method to show a view (i.e. window)
+        Protected method to show a view (i.e. window).
         
         @param win editor assembly to be shown
         @param fn filename of this editor (string)
--- a/Plugins/ViewManagerPlugins/Tabview/Tabview.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Plugins/ViewManagerPlugins/Tabview/Tabview.py	Sun Sep 29 15:54:10 2013 +0200
@@ -721,8 +721,6 @@
         Constructor
         
         @param parent parent widget (QWidget)
-        @param ui reference to the main user interface
-        @param dbs reference to the debug server object
         """
         self.tabWidgets = []
         
@@ -780,14 +778,14 @@
         
     def _removeAllViews(self):
         """
-        Protected method to remove all views (i.e. windows)
+        Protected method to remove all views (i.e. windows).
         """
         for win in self.editors:
             self._removeView(win)
         
     def _removeView(self, win):
         """
-        Protected method to remove a view (i.e. window)
+        Protected method to remove a view (i.e. window).
         
         @param win editor window to be removed
         """
@@ -822,7 +820,7 @@
         
     def _addView(self, win, fn=None, noName=""):
         """
-        Protected method to add a view (i.e. window)
+        Protected method to add a view (i.e. window).
         
         @param win editor assembly to be added
         @param fn filename of this editor (string)
@@ -860,7 +858,7 @@
         
     def insertView(self, win, tabWidget, index, fn=None, noName=""):
         """
-        Protected method to add a view (i.e. window)
+        Protected method to add a view (i.e. window).
         
         @param win editor assembly to be inserted
         @param tabWidget reference to the tab widget to insert the editor into (TabWidget)
@@ -902,7 +900,7 @@
         
     def _showView(self, win, fn=None):
         """
-        Protected method to show a view (i.e. window)
+        Protected method to show a view (i.e. window).
         
         @param win editor assembly to be shown
         @param fn filename of this editor (string)
--- a/Plugins/WizardPlugins/E5MessageBoxWizard/E5MessageBoxWizardDialog.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Plugins/WizardPlugins/E5MessageBoxWizard/E5MessageBoxWizardDialog.py	Sun Sep 29 15:54:10 2013 +0200
@@ -132,7 +132,7 @@
         self.eMessage.setEnabled(not self.rAboutQt.isChecked())
     
     @pyqtSlot(bool)
-    def on_rInformation_toggled(self, checked):
+    def on_rInformation_toggled(self, on):
         """
         Private slot to handle the toggled signal of the rInformation
         radio button.
@@ -142,7 +142,7 @@
         self.__enabledGroups()
     
     @pyqtSlot(bool)
-    def on_rQuestion_toggled(self, checked):
+    def on_rQuestion_toggled(self, on):
         """
         Private slot to handle the toggled signal of the rQuestion
         radio button.
@@ -152,7 +152,7 @@
         self.__enabledGroups()
     
     @pyqtSlot(bool)
-    def on_rWarning_toggled(self, checked):
+    def on_rWarning_toggled(self, on):
         """
         Private slot to handle the toggled signal of the rWarning
         radio button.
@@ -162,7 +162,7 @@
         self.__enabledGroups()
     
     @pyqtSlot(bool)
-    def on_rCritical_toggled(self, checked):
+    def on_rCritical_toggled(self, on):
         """
         Private slot to handle the toggled signal of the rCritical
         radio button.
@@ -172,7 +172,7 @@
         self.__enabledGroups()
     
     @pyqtSlot(bool)
-    def on_rYesNo_toggled(self, checked):
+    def on_rYesNo_toggled(self, on):
         """
         Private slot to handle the toggled signal of the rYesNo
         radio button.
@@ -182,7 +182,7 @@
         self.__enabledGroups()
     
     @pyqtSlot(bool)
-    def on_rRetryAbort_toggled(self, checked):
+    def on_rRetryAbort_toggled(self, on):
         """
         Private slot to handle the toggled signal of the rRetryAbort
         radio button.
@@ -192,7 +192,7 @@
         self.__enabledGroups()
     
     @pyqtSlot(bool)
-    def on_rOkToClearData_toggled(self, checked):
+    def on_rOkToClearData_toggled(self, on):
         """
         Private slot to handle the toggled signal of the rOkToClearData
         radio button.
@@ -202,7 +202,7 @@
         self.__enabledGroups()
     
     @pyqtSlot(bool)
-    def on_rAbout_toggled(self, checked):
+    def on_rAbout_toggled(self, on):
         """
         Private slot to handle the toggled signal of the rAbout
         radio button.
@@ -212,7 +212,7 @@
         self.__enabledGroups()
     
     @pyqtSlot(bool)
-    def on_rAboutQt_toggled(self, checked):
+    def on_rAboutQt_toggled(self, on):
         """
         Private slot to handle the toggled signal of the rAboutQt
         radio button.
@@ -222,7 +222,7 @@
         self.__enabledGroups()
     
     @pyqtSlot(bool)
-    def on_rStandard_toggled(self, checked):
+    def on_rStandard_toggled(self, on):
         """
         Private slot to handle the toggled signal of the rStandard
         radio button.
@@ -429,7 +429,6 @@
         Private method to generate the button code for the default button.
         
         @param istring indentation string (string)
-        @param indString string used for indentation (space or tab) (string)
         @return the button code (string)
         """
         btnCode = ""
--- a/Plugins/WizardPlugins/QRegularExpressionWizard/QRegularExpressionWizardDialog.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Plugins/WizardPlugins/QRegularExpressionWizard/QRegularExpressionWizardDialog.py	Sun Sep 29 15:54:10 2013 +0200
@@ -137,6 +137,7 @@
         
         @param commandDict dictionary with command string and related
             data (dict)
+        @keyparam kw parameters for the command
         @return flag indicating a successful transmission (boolean)
         """
         result = False
--- a/Preferences/ConfigurationDialog.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationDialog.py	Sun Sep 29 15:54:10 2013 +0200
@@ -84,6 +84,7 @@
             eric5 ide (boolean)
         @keyparam displayMode mode of the configuration dialog
             (DefaultMode, HelpBrowserMode, TrayStarterMode)
+        @exception RuntimeError raised to indicate an invalid dialog mode
         """
         assert displayMode in (
             ConfigurationWidget.DefaultMode,
@@ -631,7 +632,7 @@
         """
         Public method to get the page name of the current page.
         
-        @param page name of the current page (string)
+        @return page name of the current page (string)
         """
         return self.__currentConfigurationPageName
         
@@ -788,7 +789,7 @@
         """
         Public method to get the page name of the current page.
         
-        @param page name of the current page (string)
+        @return page name of the current page (string)
         """
         return self.cw.getConfigurationPageName()
         
@@ -799,6 +800,9 @@
         self.cw.setPreferences()
     
     def accept(self):
+        """
+        Public method to accept the dialog.
+        """
         super().accept()
 
 
--- a/Preferences/ConfigurationPages/ApplicationPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/ApplicationPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -106,6 +106,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = ApplicationPage()
     return page
--- a/Preferences/ConfigurationPages/ConfigurationPageBase.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/ConfigurationPageBase.py	Sun Sep 29 15:54:10 2013 +0200
@@ -33,7 +33,7 @@
         """
         Public method to save the current state of the widget.
         """
-        return None
+        return
         
     def setState(self, state):
         """
--- a/Preferences/ConfigurationPages/CooperationPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/CooperationPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -114,6 +114,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = CooperationPage()
     return page
--- a/Preferences/ConfigurationPages/CorbaPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/CorbaPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -62,6 +62,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = CorbaPage()
     return page
--- a/Preferences/ConfigurationPages/DebuggerGeneralPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/DebuggerGeneralPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -265,6 +265,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = DebuggerGeneralPage()
     return page
--- a/Preferences/ConfigurationPages/DebuggerPython3Page.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/DebuggerPython3Page.py	Sun Sep 29 15:54:10 2013 +0200
@@ -115,6 +115,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = DebuggerPython3Page()
     return page
--- a/Preferences/ConfigurationPages/DebuggerPythonPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/DebuggerPythonPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -111,6 +111,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = DebuggerPythonPage()
     return page
--- a/Preferences/ConfigurationPages/DebuggerRubyPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/DebuggerRubyPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -68,6 +68,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = DebuggerRubyPage()
     return page
--- a/Preferences/ConfigurationPages/EditorAPIsPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EditorAPIsPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -265,6 +265,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EditorAPIsPage()
     return page
--- a/Preferences/ConfigurationPages/EditorAutocompletionPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EditorAutocompletionPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -54,6 +54,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EditorAutocompletionPage()
     return page
--- a/Preferences/ConfigurationPages/EditorAutocompletionQScintillaPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EditorAutocompletionQScintillaPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -63,6 +63,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EditorAutocompletionQScintillaPage()
     return page
--- a/Preferences/ConfigurationPages/EditorCalltipsPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EditorCalltipsPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -77,6 +77,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EditorCalltipsPage()
     return page
--- a/Preferences/ConfigurationPages/EditorCalltipsQScintillaPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EditorCalltipsQScintillaPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -57,6 +57,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EditorCalltipsQScintillaPage()
     return page
--- a/Preferences/ConfigurationPages/EditorExportersPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EditorExportersPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -183,6 +183,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EditorExportersPage()
     return page
--- a/Preferences/ConfigurationPages/EditorFilePage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EditorFilePage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -273,6 +273,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EditorFilePage()
     return page
--- a/Preferences/ConfigurationPages/EditorGeneralPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EditorGeneralPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -95,6 +95,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EditorGeneralPage()
     return page
--- a/Preferences/ConfigurationPages/EditorHighlightersPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EditorHighlightersPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -103,7 +103,8 @@
     @pyqtSlot()
     def on_deleteLexerButton_clicked(self):
         """
-        Private slot to delete the currently selected lexer association of the list.
+        Private slot to delete the currently selected lexer association of the
+        list.
         """
         itmList = self.editorLexerList.selectedItems()
         if itmList:
@@ -117,10 +118,12 @@
         
     def on_editorLexerList_itemClicked(self, itm, column):
         """
-        Private slot to handle the clicked signal of the lexer association list.
+        Private slot to handle the clicked signal of the lexer association
+        list.
         
         @param itm reference to the selecte item (QTreeWidgetItem)
-        @param column column the item was clicked or activated (integer) (ignored)
+        @param column column the item was clicked or activated (integer)
+            (ignored)
         """
         if itm is None:
             self.editorFileExtEdit.clear()
@@ -141,10 +144,12 @@
         
     def on_editorLexerList_itemActivated(self, itm, column):
         """
-        Private slot to handle the activated signal of the lexer association list.
+        Private slot to handle the activated signal of the lexer association
+        list.
         
         @param itm reference to the selecte item (QTreeWidgetItem)
-        @param column column the item was clicked or activated (integer) (ignored)
+        @param column column the item was clicked or activated (integer)
+            (ignored)
         """
         self.on_editorLexerList_itemClicked(itm, column)
     
@@ -152,6 +157,8 @@
     def on_editorLexerCombo_currentIndexChanged(self, text):
         """
         Private slot to handle the selection of a lexer.
+        
+        @param text text of the lexer combo (string)
         """
         if text in self.extras:
             self.pygmentsLexerCombo.setEnabled(True)
@@ -166,6 +173,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EditorHighlightersPage(dlg.getLexers())
     return page
--- a/Preferences/ConfigurationPages/EditorHighlightingStylesPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EditorHighlightingStylesPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -464,6 +464,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EditorHighlightingStylesPage(dlg.getLexers())
     return page
--- a/Preferences/ConfigurationPages/EditorKeywordsPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EditorKeywordsPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -121,6 +121,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EditorKeywordsPage()
     return page
--- a/Preferences/ConfigurationPages/EditorPropertiesPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EditorPropertiesPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -474,6 +474,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EditorPropertiesPage(dlg.getLexers())
     return page
--- a/Preferences/ConfigurationPages/EditorSearchPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EditorSearchPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -63,6 +63,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EditorSearchPage()
     return page
--- a/Preferences/ConfigurationPages/EditorSpellCheckingPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EditorSpellCheckingPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -126,6 +126,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EditorSpellCheckingPage()
     return page
--- a/Preferences/ConfigurationPages/EditorStylesPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EditorStylesPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -433,6 +433,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EditorStylesPage()
     return page
--- a/Preferences/ConfigurationPages/EditorSyntaxPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EditorSyntaxPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -64,6 +64,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EditorSyntaxPage()
     return page
--- a/Preferences/ConfigurationPages/EditorTypingPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EditorTypingPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -153,6 +153,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EditorTypingPage()
     return page
--- a/Preferences/ConfigurationPages/EmailPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/EmailPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -168,6 +168,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = EmailPage()
     return page
--- a/Preferences/ConfigurationPages/GraphicsPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/GraphicsPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -56,6 +56,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = GraphicsPage()
     return page
--- a/Preferences/ConfigurationPages/HelpAppearancePage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/HelpAppearancePage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -138,6 +138,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = HelpAppearancePage()
     return page
--- a/Preferences/ConfigurationPages/HelpDocumentationPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/HelpDocumentationPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -192,6 +192,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = HelpDocumentationPage()
     return page
--- a/Preferences/ConfigurationPages/HelpInterfacePage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/HelpInterfacePage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -81,6 +81,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = HelpInterfacePage()
     return page
--- a/Preferences/ConfigurationPages/HelpViewersPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/HelpViewersPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -131,6 +131,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = HelpViewersPage()
     return page
--- a/Preferences/ConfigurationPages/HelpVirusTotalPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/HelpVirusTotalPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -101,6 +101,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = HelpVirusTotalPage(dlg)
     return page
--- a/Preferences/ConfigurationPages/HelpWebBrowserPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/HelpWebBrowserPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -298,6 +298,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = HelpWebBrowserPage(dlg)
     return page
--- a/Preferences/ConfigurationPages/IconsPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/IconsPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -175,6 +175,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = IconsPage()
     return page
--- a/Preferences/ConfigurationPages/InterfacePage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/InterfacePage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -255,7 +255,7 @@
     @pyqtSlot()
     def on_resetLayoutButton_clicked(self):
         """
-        Private method to reset layout to factory defaults
+        Private method to reset layout to factory defaults.
         """
         Preferences.resetLayout()
     
@@ -265,6 +265,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = InterfacePage()
     return page
--- a/Preferences/ConfigurationPages/IrcPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/IrcPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -159,6 +159,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = IrcPage()
     return page
--- a/Preferences/ConfigurationPages/MasterPasswordEntryDialog.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/MasterPasswordEntryDialog.py	Sun Sep 29 15:54:10 2013 +0200
@@ -97,11 +97,15 @@
     def getMasterPassword(self):
         """
         Public method to get the new master password.
+        
+        @return new master password (string)
         """
         return self.newPasswordEdit.text()
     
     def getCurrentPassword(self):
         """
         Public method to get the current master password.
+        
+        @return current master password (string)
         """
         return self.currentPasswordEdit.text()
--- a/Preferences/ConfigurationPages/MultiProjectPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/MultiProjectPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -77,6 +77,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = MultiProjectPage()
     return page
--- a/Preferences/ConfigurationPages/NetworkPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/NetworkPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -203,6 +203,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = NetworkPage()
     return page
--- a/Preferences/ConfigurationPages/NotificationsPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/NotificationsPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -24,8 +24,6 @@
     def __init__(self):
         """
         Constructor
-        
-        @param parent reference to the parent widget (QWidget)
         """
         super().__init__()
         self.setupUi(self)
@@ -93,6 +91,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = NotificationsPage()
     return page
--- a/Preferences/ConfigurationPages/PluginManagerPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/PluginManagerPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -73,6 +73,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = PluginManagerPage()
     return page
--- a/Preferences/ConfigurationPages/PrinterPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/PrinterPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -97,6 +97,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = PrinterPage()
     return page
--- a/Preferences/ConfigurationPages/ProjectBrowserPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/ProjectBrowserPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -166,6 +166,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = ProjectBrowserPage()
     return page
--- a/Preferences/ConfigurationPages/ProjectPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/ProjectPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -96,6 +96,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = ProjectPage()
     return page
--- a/Preferences/ConfigurationPages/PythonPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/PythonPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -68,6 +68,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = PythonPage()
     return page
--- a/Preferences/ConfigurationPages/QtPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/QtPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -93,6 +93,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = QtPage()
     return page
--- a/Preferences/ConfigurationPages/SecurityPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/SecurityPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -110,6 +110,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = SecurityPage(dlg)
     return page
--- a/Preferences/ConfigurationPages/ShellPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/ShellPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -102,6 +102,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = ShellPage()
     return page
--- a/Preferences/ConfigurationPages/TasksPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/TasksPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -68,6 +68,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = TasksPage()
     return page
--- a/Preferences/ConfigurationPages/TemplatesPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/TemplatesPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -57,6 +57,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = TemplatesPage()
     return page
--- a/Preferences/ConfigurationPages/TrayStarterPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/TrayStarterPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -64,6 +64,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = TrayStarterPage()
     return page
--- a/Preferences/ConfigurationPages/VcsPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/VcsPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -75,6 +75,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = VcsPage()
     return page
--- a/Preferences/ConfigurationPages/ViewmanagerPage.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ConfigurationPages/ViewmanagerPage.py	Sun Sep 29 15:54:10 2013 +0200
@@ -86,6 +86,7 @@
     Module function to create the configuration page.
     
     @param dlg reference to the configuration dialog
+    @return reference to the instantiated page (ConfigurationPageBase)
     """
     page = ViewmanagerPage()
     return page
--- a/Preferences/PreferencesLexer.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/PreferencesLexer.py	Sun Sep 29 15:54:10 2013 +0200
@@ -50,6 +50,8 @@
     def __init__(self, language):
         """
         Constructor
+        
+        @param language lexer language (string)
         """
         PreferencesLexerError.__init__(self)
         self._errorMessage = \
@@ -67,6 +69,8 @@
         
         @param language The lexer language. (string)
         @param parent The parent widget of this lexer. (QextScintilla)
+        @exception PreferencesLexerLanguageError raised to indicate an invalid
+            lexer language
         """
         super().__init__(parent)
         
--- a/Preferences/ViewProfileDialog.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/ViewProfileDialog.py	Sun Sep 29 15:54:10 2013 +0200
@@ -27,6 +27,7 @@
         @param debugVisibilities list  of flags giving the visibilities
             of the various parts for the 'debug' view profile (list of boolean)
         @param parent parent widget of this dialog (QWidget)
+        @exception ValueError raised to indicate an invalid layout
         """
         super().__init__(parent)
         
--- a/Preferences/__init__.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Preferences/__init__.py	Sun Sep 29 15:54:10 2013 +0200
@@ -1214,7 +1214,7 @@
     Module function to retrieve the variables filter settings.
     
     @param prefClass preferences class used as the storage area
-    @return a tuple defing the variables filter
+    @return a tuple defining the variables filter
     """
     localsFilter = eval(prefClass.settings.value("Variables/LocalsFilter",
         prefClass.varDefaults["LocalsFilter"]))
@@ -1227,6 +1227,7 @@
     """
     Module function to store the variables filter settings.
     
+    qparam filters variable filters to set 
     @param prefClass preferences class used as the storage area
     """
     prefClass.settings.setValue("Variables/LocalsFilter", str(filters[0]))
@@ -2768,6 +2769,8 @@
 def saveResetLayout(prefClass=Prefs):
     """
     Module function to save the reset layout.
+    
+    @param prefClass preferences class used as the storage area
     """
     if prefClass.resetLayout:
         for key in list(prefClass.geometryDefaults.keys()):
--- a/Project/AddFoundFilesDialog.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Project/AddFoundFilesDialog.py	Sun Sep 29 15:54:10 2013 +0200
@@ -17,12 +17,10 @@
     """
     Class implementing a dialog to show the found files to the user.
     
-    The found files are displayed in a listview.
-    Pressing the 'Add All' button adds all files to the current project,
-    the 'Add Selected' button adds only the selected files and the 'Cancel'
-    button cancels the operation.
+    The found files are displayed in a listview. Pressing the 'Add All' button
+    adds all files to the current project, the 'Add Selected' button adds only
+    the selected files and the 'Cancel' button cancels the operation.
     """
-    
     def __init__(self, files, parent=None, name=None):
         """
         Constructor
@@ -61,7 +59,7 @@
         """
         Private slot to handle the 'Add All' button press.
         
-        @return always 1 (int)
+        Always returns the value 1 (integer).
         """
         self.done(1)
         
@@ -70,7 +68,7 @@
         """
         Private slot to handle the 'Add Selected' button press.
         
-        @return always 2 (int)
+        Always returns the value 2 (integer).
         """
         self.done(2)
         
--- a/Project/NewPythonPackageDialog.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Project/NewPythonPackageDialog.py	Sun Sep 29 15:54:10 2013 +0200
@@ -21,7 +21,9 @@
         """
         Constructor
         
-        @param relPath initial package path relative to the project root (string)
+        @param relPath initial package path relative to the project root
+            (string)
+        @param parent reference to the parent widget (QWidget)
         """
         super().__init__(parent)
         self.setupUi(self)
--- a/Project/Project.py	Sun Sep 29 15:23:19 2013 +0200
+++ b/Project/Project.py	Sun Sep 29 15:54:10 2013 +0200
@@ -755,7 +755,7 @@
         
     def __readUserProperties(self):
         """
-        Private method to read in the user specific project file (.e4q)
+        Private method to read in the user specific project file (.e4q).
         """
         if self.pfile is None:
             return
@@ -813,7 +813,7 @@
         
     def __readSession(self, quiet=False, indicator=""):
         """
-        Private method to read in the project session file (.e4s)
+        Private method to read in the project session file (.e4s).
         
         @param quiet flag indicating quiet operations.
                 If this flag is true, no errors are reported.
@@ -898,7 +898,7 @@
         
     def __readTasks(self):
         """
-        Private method to read in the project tasks file (.e4t)
+        Private method to read in the project tasks file (.e4t).
         """
         if self.pfile is None:
             E5MessageBox.critical(self.ui,
@@ -964,7 +964,7 @@
         
     def __readDebugProperties(self, quiet=False):
         """
-        Private method to read in the project debugger properties file (.e4d)
+        Private method to read in the project debugger properties file (.e4d).
         
         @param quiet flag indicating quiet operations.
                 If this flag is true, no errors are reported.
@@ -994,7 +994,7 @@
         
     def __writeDebugProperties(self, quiet=False):
         """
-        Private method to write the project debugger properties file (.e4d)
+        Private method to write the project debugger properties file (.e4d).
         
         @param quiet flag indicating quiet operations.
                 If this flag is true, no errors are reported.
@@ -1025,7 +1025,7 @@
         
     def __deleteDebugProperties(self):
         """
-        Private method to delete the project debugger properties file (.e4d)
+        Private method to delete the project debugger properties file (.e4d).
         """
         if self.pfile is None:
             E5MessageBox.critical(self.ui,
@@ -1684,6 +1684,7 @@
         Public method to get all files starting with a common prefix.
         
         @param start prefix (string)
+        @return list of files starting with a common prefix (list of strings)
         """
         filelist = []
         start = self.getRelativePath(start)
@@ -2859,6 +2860,8 @@
         Public method to check, if a path starts with the project path.
         
         @param path path to be checked (string)
+        @return flag indicating that the path starts with the project path
+            (boolean)
         """
         if self.ppath:
             if path == self.ppath:

eric ide

mercurial