Plugins/VcsPlugins/vcsPySvn/subversion.py

changeset 2963
745d38097b7f
parent 2845
7e55c6268c35
child 3009
bf5ae5d7477d
--- 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

eric ide

mercurial