Mercurial Repositories > eric / changeset

--- a/Plugins/VcsPlugins/vcsPySvn/SvnLoginDialog.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsPySvn/SvnLoginDialog.py	Sun Sep 29 15:23:19 2013 +0200
@@ -24,12 +24,14 @@
         @param username username as supplied by subversion (string)
         @param may_save flag indicating, that subversion is willing to save
             the answers returned (boolean)
+        qparam parent reference to the parent widget (QWidget)
         """
         super().__init__(parent)
         self.setupUi(self)
         
-        self.realmLabel.setText(self.trUtf8("<b>Enter login data for realm {0}.</b>")\
-                                .format(realm))
+        self.realmLabel.setText(
+            self.trUtf8("<b>Enter login data for realm {0}.</b>")
+            .format(realm))
         self.usernameEdit.setText(username)
         self.saveCheckBox.setEnabled(may_save)
         if not may_save:

--- a/Plugins/VcsPlugins/vcsPySvn/SvnMergeDialog.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsPySvn/SvnMergeDialog.py	Sun Sep 29 15:23:19 2013 +0200
@@ -48,8 +48,6 @@
     def __enableOkButton(self):
         """
         Private method used to enable/disable the OK-button.
-        
-        @param text ignored
         """
         self.okButton.setDisabled(
             self.tag1Combo.currentText() == "" or \
@@ -64,12 +62,16 @@
     def on_tag1Combo_editTextChanged(self, text):
         """
         Private slot to handle the tag1Combo editTextChanged signal.
+        
+        @param text text of the combo (string)
         """
         self.__enableOkButton()
         
     def on_tag2Combo_editTextChanged(self, text):
         """
         Private slot to handle the tag2Combo editTextChanged signal.
+        
+        @param text text of the combo (string)
         """
         self.__enableOkButton()
         

--- a/Plugins/VcsPlugins/vcsPySvn/SvnOptionsDialog.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsPySvn/SvnOptionsDialog.py	Sun Sep 29 15:23:19 2013 +0200
@@ -84,6 +84,8 @@
     def on_protocolCombo_activated(self, protocol):
         """
         Private slot to switch the status of the directory selection button.
+        
+        @param protocol selected protocol (string)
         """
         if protocol == "file://":
             self.networkPath = self.vcsUrlEdit.text()

--- a/Plugins/VcsPlugins/vcsPySvn/SvnStatusDialog.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsPySvn/SvnStatusDialog.py	Sun Sep 29 15:23:19 2013 +0200
@@ -884,6 +884,7 @@
         """
         Private method to retrieve all entries, that have a locked status.
         
+        @param indicators list of indicators to check against (list of strings)
         @return list of all items with a locked status
         """
         lockitems = []

--- a/Plugins/VcsPlugins/vcsPySvn/SvnTagBranchListDialog.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsPySvn/SvnTagBranchListDialog.py	Sun Sep 29 15:23:19 2013 +0200
@@ -61,6 +61,7 @@
         @param path name of directory to be listed (string)
         @param tags flag indicating a list of tags is requested
                 (False = branches, True = tags)
+        @return flag indicating success (boolean)
         """
         self.errorGroup.hide()
         

--- a/Plugins/VcsPlugins/vcsPySvn/SvnUrlSelectionDialog.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsPySvn/SvnUrlSelectionDialog.py	Sun Sep 29 15:23:19 2013 +0200
@@ -94,7 +94,7 @@
         selected type.
         
         @param labelCombo reference to the labelCombo object (QComboBox)
-        @param type type string (string)
+        @param type_ type string (string)
         """
         if type_ == "trunk/":
             labelCombo.clear()

--- a/Plugins/VcsPlugins/vcsPySvn/subversion.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsPySvn/subversion.py	Sun Sep 29 15:23:19 2013 +0200
@@ -1606,17 +1606,22 @@
         
         @param project reference to the project object
         @param archive name of the project in the repository (string)
-        @param editable flag indicating that the project name is editable (boolean)
+        @param editable flag indicating that the project name is editable
+            (boolean)
         @param parent parent widget (QWidget)
+        @return reference to the instantiated options dialog (SvnOptionsDialog)
         """
         from .SvnOptionsDialog import SvnOptionsDialog
         return SvnOptionsDialog(self, project, parent)
         
     def vcsNewProjectOptionsDialog(self, parent=None):
         """
-        Public method to get a dialog to enter repository info for getting a new project.
+        Public method to get a dialog to enter repository info for getting a
+        new project.
         
         @param parent parent widget (QWidget)
+        @return reference to the instantiated options dialog
+            (SvnNewProjectOptionsDialog)
         """
         from .SvnNewProjectOptionsDialog import SvnNewProjectOptionsDialog
         return SvnNewProjectOptionsDialog(self, parent)
@@ -2040,12 +2045,13 @@
     
     def svnSbsDiff(self, name, extended=False, revisions=None):
         """
-        Public method used to view the difference of a file to the Mercurial repository
-        side-by-side.
+        Public method used to view the difference of a file to the Mercurial
+        repository side-by-side.
         
         @param name file name to be diffed (string)
         @keyparam extended flag indicating the extended variant (boolean)
         @keyparam revisions tuple of two revisions (tuple of strings)
+        @exception ValueError raised to indicate an invalid name parameter type
         """
         if isinstance(name, list):
             raise ValueError("Wrong parameter type")
@@ -2451,10 +2457,12 @@
 
     def _createStatusMonitorThread(self, interval, project):
         """
-        Protected method to create an instance of the VCS status monitor thread.
+        Protected method to create an instance of the VCS status monitor
+        thread.
         
+        @param interval check interval for the monitor thread in seconds
+            (integer)
         @param project reference to the project object
-        @param interval check interval for the monitor thread in seconds (integer)
         @return reference to the monitor thread (QThread)
         """
         from .SvnStatusMonitorThread import SvnStatusMonitorThread

--- a/Plugins/VcsPlugins/vcsSubversion/Config.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsSubversion/Config.py	Sun Sep 29 15:23:19 2013 +0200
@@ -4,7 +4,7 @@
 #
 
 """
-Module defining configuration variables for the subversion package
+Module defining configuration variables for the subversion package.
 """
 
 # Available protocols for the repository URL

--- a/Plugins/VcsPlugins/vcsSubversion/SvnCommitDialog.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsSubversion/SvnCommitDialog.py	Sun Sep 29 15:23:19 2013 +0200
@@ -120,6 +120,8 @@
     def on_recentComboBox_activated(self, txt):
         """
         Private slot to select a commit message from recent ones.
+        
+        @param txt text of the combo (string)
         """
         if txt:
             self.logEdit.setPlainText(txt)

--- a/Plugins/VcsPlugins/vcsSubversion/SvnLogBrowserDialog.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsSubversion/SvnLogBrowserDialog.py	Sun Sep 29 15:23:19 2013 +0200
@@ -585,7 +585,9 @@
     @pyqtSlot(bool)
     def on_stopCheckBox_clicked(self, checked):
         """
-        Private slot called, when the stop on copy/move checkbox is clicked
+        Private slot called, when the stop on copy/move checkbox is clicked.
+        
+        @param checked flag indicating the checked state (boolean)
         """
         self.vcs.getPlugin().setPreferences("StopLogOnCopy",
                                             self.stopCheckBox.isChecked())

--- a/Plugins/VcsPlugins/vcsSubversion/SvnMergeDialog.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsSubversion/SvnMergeDialog.py	Sun Sep 29 15:23:19 2013 +0200
@@ -48,8 +48,6 @@
     def __enableOkButton(self):
         """
         Private method used to enable/disable the OK-button.
-        
-        @param text ignored
         """
         self.okButton.setDisabled(
             self.tag1Combo.currentText() != "" or \
@@ -64,12 +62,16 @@
     def on_tag1Combo_editTextChanged(self, text):
         """
         Private slot to handle the tag1Combo editTextChanged signal.
+        
+        @param text text of the combo (string)
         """
         self.__enableOkButton()
         
     def on_tag2Combo_editTextChanged(self, text):
         """
         Private slot to handle the tag2Combo editTextChanged signal.
+        
+        @param text text of the combo (string)
         """
         self.__enableOkButton()
         

--- a/Plugins/VcsPlugins/vcsSubversion/SvnOptionsDialog.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsSubversion/SvnOptionsDialog.py	Sun Sep 29 15:23:19 2013 +0200
@@ -84,6 +84,8 @@
     def on_protocolCombo_activated(self, protocol):
         """
         Private slot to switch the status of the directory selection button.
+        
+        @param protocol selected protocol (string)
         """
         if protocol == "file://":
             self.networkPath = self.vcsUrlEdit.text()

--- a/Plugins/VcsPlugins/vcsSubversion/SvnRepoBrowserDialog.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsSubversion/SvnRepoBrowserDialog.py	Sun Sep 29 15:23:19 2013 +0200
@@ -92,11 +92,10 @@
         self.repoTree.header().setStretchLastSection(True)
     
     def __generateItem(self, repopath, revision, author, size, date,
-            nodekind, url):
+                       nodekind, url):
         """
         Private method to generate a tree item in the repository tree.
         
-        @param parent parent of the item to be created (QTreeWidget or QTreeWidgetItem)
         @param repopath path of the item (string)
         @param revision revision info (string)
         @param author author info (string)

--- a/Plugins/VcsPlugins/vcsSubversion/SvnStatusDialog.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsSubversion/SvnStatusDialog.py	Sun Sep 29 15:23:19 2013 +0200
@@ -995,6 +995,7 @@
         """
         Private method to retrieve all emtries, that have a locked status.
         
+        @param indicators list of indicators to check against (list of strings)
         @return list of all items with a locked status
         """
         lockitems = []

--- a/Plugins/VcsPlugins/vcsSubversion/SvnTagBranchListDialog.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsSubversion/SvnTagBranchListDialog.py	Sun Sep 29 15:23:19 2013 +0200
@@ -72,9 +72,10 @@
         
         @param path name of directory to be listed (string)
         @param tags flag indicating a list of tags is requested
-                (False = branches, True = tags)
-        @param tagsList reference to string list receiving the tags (list of strings)
-        @param allsTagsList reference to string list all tags (list of strings)
+            (False = branches, True = tags)
+        @param tagsList reference to string list receiving the tags
+            (list of strings)
+        @param allTagsList reference to string list all tags (list of strings)
         """
         self.errorGroup.hide()
         

--- a/Plugins/VcsPlugins/vcsSubversion/SvnUrlSelectionDialog.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsSubversion/SvnUrlSelectionDialog.py	Sun Sep 29 15:23:19 2013 +0200
@@ -92,7 +92,7 @@
         selected type.
         
         @param labelCombo reference to the labelCombo object (QComboBox)
-        @param type type string (string)
+        @param type_ type string (string)
         """
         if type_ == "trunk/":
             labelCombo.clear()

--- a/Plugins/VcsPlugins/vcsSubversion/__init__.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsSubversion/__init__.py	Sun Sep 29 15:23:19 2013 +0200
@@ -4,7 +4,7 @@
 #
 
 """
-Package implementing the vcs interface to Subversion
+Package implementing the vcs interface to Subversion.
 
 It consists of the subversion class, the project helper classes and some
 Subversion specific dialogs.

--- a/Plugins/VcsPlugins/vcsSubversion/subversion.py	Sun Sep 29 15:08:57 2013 +0200
+++ b/Plugins/VcsPlugins/vcsSubversion/subversion.py	Sun Sep 29 15:23:19 2013 +0200
@@ -1008,6 +1008,7 @@
         Public method used to switch a directory to a different tag/branch.
         
         @param name directory name to be switched (string)
+        @return flag indicating added or changed files (boolean)
         """
         dname, fname = self.splitPath(name)
         
@@ -1435,17 +1436,22 @@
         
         @param project reference to the project object
         @param archive name of the project in the repository (string)
-        @param editable flag indicating that the project name is editable (boolean)
+        @param editable flag indicating that the project name is editable
+            (boolean)
         @param parent parent widget (QWidget)
+        @return reference to the instantiated options dialog (SvnOptionsDialog)
         """
         from .SvnOptionsDialog import SvnOptionsDialog
         return SvnOptionsDialog(self, project, parent)
         
     def vcsNewProjectOptionsDialog(self, parent=None):
         """
-        Public method to get a dialog to enter repository info for getting a new project.
+        Public method to get a dialog to enter repository info for getting
+        a new project.
         
         @param parent parent widget (QWidget)
+        @return reference to the instantiated options dialog
+            (SvnNewProjectOptionsDialog)
         """
         from .SvnNewProjectOptionsDialog import SvnNewProjectOptionsDialog
         return SvnNewProjectOptionsDialog(self, parent)
@@ -1875,12 +1881,13 @@
     
     def svnSbsDiff(self, name, extended=False, revisions=None):
         """
-        Public method used to view the difference of a file to the Mercurial repository
-        side-by-side.
+        Public method used to view the difference of a file to the Mercurial
+        repository side-by-side.
         
         @param name file name to be diffed (string)
         @keyparam extended flag indicating the extended variant (boolean)
         @keyparam revisions tuple of two revisions (tuple of strings)
+        @exception ValueError raised to indicate an illegal name parameter type
         """
         if isinstance(name, list):
             raise ValueError("Wrong parameter type")
@@ -2245,8 +2252,8 @@
         """
         Protected method to create an instance of the VCS status monitor thread.
         
+        @param interval check interval for the monitor thread in seconds (integer)
         @param project reference to the project object
-        @param interval check interval for the monitor thread in seconds (integer)
         @return reference to the monitor thread (QThread)
         """
         from .SvnStatusMonitorThread import SvnStatusMonitorThread