Mercurial Repositories > eric / file diff

diff -r f6881d10e995 -r 2f70ca07f0af src/eric7/Plugins/PluginVcsGit.py
--- a/src/eric7/Plugins/PluginVcsGit.py	Fri Dec 22 17:24:07 2023 +0100
+++ b/src/eric7/Plugins/PluginVcsGit.py	Fri Dec 22 19:45:17 2023 +0100
@@ -45,6 +45,7 @@
 
     @return dictionary containing the data to query the presence of
         the executable
+    @rtype dict
     """
     exe = "git"
     if OSUtilities.isWindowsPlatform():
@@ -69,7 +70,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
     """
     ##global __header__
     data = {}
@@ -86,7 +88,8 @@
     """
     Public function to get the display string.
 
-    @return display string (string)
+    @return display string
+    @rtype str
     """
     exe = "git"
     if OSUtilities.isWindowsPlatform():
@@ -104,8 +107,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 GitPage
     """
     from eric7.Plugins.VcsPlugins.vcsGit.ConfigurationPage.GitPage import GitPage
 
@@ -121,8 +126,8 @@
     """
     Module function returning data as required by the configuration dialog.
 
-    @return dictionary with key "zzz_gitPage" containing the relevant
-        data
+    @return dictionary with key "zzz_gitPage" containing the relevant data
+    @rtype dict
     """
     return {
         "zzz_gitPage": [
@@ -184,7 +189,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.vcsGit.ProjectHelper import GitProjectHelper
 
@@ -206,6 +212,7 @@
         Public method to get a reference to the project helper object.
 
         @return reference to the project helper object
+        @rtype GitProjectHelper
         """
         return self.__projectHelperObject
 
@@ -213,9 +220,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)
@@ -224,8 +232,9 @@
         """
         Public method to activate this plugin.
 
-        @return tuple of reference to instantiated viewmanager and
-            activation status (boolean)
+        @return tuple of reference to instantiated version control and
+            activation status
+        @rtype tuple of (Git, bool)
         """
         from eric7.Plugins.VcsPlugins.vcsGit.git import Git
 
@@ -261,7 +270,9 @@
         Class 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",
@@ -304,7 +315,9 @@
         Class 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("Git/" + key, value)
 
@@ -312,7 +325,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()