Mercurial Repositories > eric / file diff

--- a/src/eric7/Plugins/PluginVcsSubversion.py	Fri Dec 22 17:24:07 2023 +0100
+++ b/src/eric7/Plugins/PluginVcsSubversion.py	Fri Dec 22 19:45:17 2023 +0100
@@ -50,6 +50,7 @@
 
     @return dictionary containing the data to query the presence of
         the executable
+    @rtype dict
     """
     exe = "svn"
     if OSUtilities.isWindowsPlatform():
@@ -76,9 +77,9 @@
     Public function to get the indicators for this version control system.
 
     @return dictionary with indicator as key and a tuple with the vcs name
-        (string) and vcs display string (string)
+        and vcs display string
+    @rtype dict
     """
-    ##global pluginTypename
     data = {}
     exe = "svn"
     if OSUtilities.isWindowsPlatform():
@@ -93,7 +94,8 @@
     """
     Public function to get the display string.
 
-    @return display string (string)
+    @return display string
+    @rtype str
     """
     exe = "svn"
     if OSUtilities.isWindowsPlatform():
@@ -111,8 +113,10 @@
     """
     Module function to create the configuration page.
 
-    @param configDlg reference to the configuration dialog (QDialog)
+    @param configDlg reference to the configuration dialog
+    @type QDialog
     @return reference to the configuration page
+    @rtype SubversionPage
     """
     from eric7.Plugins.VcsPlugins.vcsSubversion.ConfigurationPage import SubversionPage
 
@@ -129,6 +133,7 @@
     Module function returning data as required by the configuration dialog.
 
     @return dictionary with key "zzz_subversionPage" containing the relevant
+    @rtype dict
     data
     """
     return {
@@ -161,7 +166,8 @@
         """
         Constructor
 
-        @param ui reference to the user interface object (UI.UserInterface)
+        @param ui reference to the user interface object
+        @type UserInterface
         """
         from eric7.Plugins.VcsPlugins.vcsSubversion.ProjectHelper import (
             SvnProjectHelper,
@@ -189,6 +195,7 @@
         Public method to get a reference to the project helper object.
 
         @return reference to the project helper object
+        @rtype SvnProjectHelper
         """
         return self.__projectHelperObject
 
@@ -196,9 +203,10 @@
         """
         Public slot to initialize the VCS toolbar.
 
-        @param ui reference to the main window (UserInterface)
+        @param ui reference to the main window
+        @type UserInterface
         @param toolbarManager reference to a toolbar manager object
-            (EricToolBarManager)
+        @type EricToolBarManager
         """
         if self.__projectHelperObject:
             self.__projectHelperObject.initToolbar(ui, toolbarManager)
@@ -208,7 +216,8 @@
         Public method to activate this plugin.
 
         @return tuple of reference to instantiated viewmanager and
-            activation status (boolean)
+            activation status
+        @rtype tuple of (Subversion, bool)
         """
         from eric7.Plugins.VcsPlugins.vcsSubversion.subversion import Subversion
 
@@ -243,7 +252,9 @@
         Public method to retrieve the various settings.
 
         @param key the key of the value to get
+        @type str
         @return the requested setting
+        @rtype Any
         """
         if key in ["StopLogOnCopy"]:
             return Preferences.toBool(
@@ -269,7 +280,9 @@
         Public method to store the various settings.
 
         @param key the key of the setting to be set
+        @type str
         @param value the value to be set
+        @type Any
         """
         Preferences.getSettings().setValue("Subversion/" + key, value)
 
@@ -277,7 +290,8 @@
         """
         Public method to get the filename of the servers file.
 
-        @return filename of the servers file (string)
+        @return filename of the servers file
+        @rtype str
         """
         return getServersPath()
 
@@ -285,7 +299,8 @@
         """
         Public method to get the filename of the config file.
 
-        @return filename of the config file (string)
+        @return filename of the config file
+        @rtype str
         """
         return getConfigPath()