Mercurial Repositories > eric / file diff

diff -r f6881d10e995 -r 2f70ca07f0af src/eric7/Plugins/PluginVcsPySvn.py
--- a/src/eric7/Plugins/PluginVcsPySvn.py	Fri Dec 22 17:24:07 2023 +0100
+++ b/src/eric7/Plugins/PluginVcsPySvn.py	Fri Dec 22 19:45:17 2023 +0100
@@ -44,6 +44,7 @@
     Public method to support the display of some executable info.
 
     @return dictionary containing the data to be shown
+    @rtype dict
     """
     try:
         import pysvn  # __IGNORE_WARNING_I10__
@@ -74,7 +75,8 @@
     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
     """
     return {
         ".svn": (__header__["pluginTypename"], displayString()),
@@ -86,7 +88,8 @@
     """
     Public function to get the display string.
 
-    @return display string (string)
+    @return display string
+    @rtype str
     """
     if importlib.util.find_spec("pysvn") is None:
         return ""
@@ -101,8 +104,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.vcsPySvn.ConfigurationPage.SubversionPage import (
         SubversionPage,
@@ -122,6 +127,7 @@
 
     @return dictionary with key "zzz_subversionPage" containing the relevant
     data
+    @rtype dict
     """
     return {
         "zzz_subversionPage": [
@@ -153,7 +159,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.vcsPySvn.ProjectHelper import PySvnProjectHelper
 
@@ -179,6 +186,7 @@
         Public method to get a reference to the project helper object.
 
         @return reference to the project helper object
+        @rtype PySvnProjectHelper
         """
         return self.__projectHelperObject
 
@@ -186,9 +194,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)
@@ -198,7 +207,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.vcsPySvn.subversion import Subversion
 
@@ -233,7 +243,9 @@
         Public method to retrieve the various settings.
 
         @param key the key of the value to get
+        @type str
         @return the requested refactoring setting
+        @rtype Any
         """
         if key in ["StopLogOnCopy"]:
             return Preferences.toBool(
@@ -259,7 +271,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)
 
@@ -267,7 +281,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()
 
@@ -275,7 +290,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()