src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/ProjectBrowserHelper.py

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 9653
e67609152c5e
child 10439
21c28b0f9e41
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/ProjectBrowserHelper.py	Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/ProjectBrowserHelper.py	Sat Dec 23 15:40:23 2023 +0100
@@ -24,8 +24,11 @@
         Constructor
 
         @param vcsObject reference to the vcs object
+        @type Hg
         @param browserObject reference to the project browser object
+        @type ProjectBaseBrowser
         @param projectObject reference to the project object
+        @type Project
         """
         super().__init__(vcsObject, browserObject, projectObject)
 
@@ -33,9 +36,9 @@
         """
         Public method to generate the extension menus.
 
-        @return dictionary of populated menu (dict of QMenu). The dict
-            must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu'
-            and 'dirMultiMenu'.
+        @return dictionary of populated menu. The dict must have the keys 'mainMenu',
+            'multiMenu', 'backMenu', 'dirMenu' and 'dirMultiMenu'.
+        @rtype dict of QMenu
         """
         self.__menus = {}
 
@@ -65,7 +68,8 @@
         """
         Public method to get the menu title.
 
-        @return title of the menu (string)
+        @return title of the menu
+        @rtype str
         """
         return self.tr("Shelve")
 
@@ -73,11 +77,12 @@
         """
         Public method to prepare the extension menu for display.
 
-        @param key menu key (string, one of 'mainMenu', 'multiMenu',
-            'backMenu', 'dirMenu' or 'dirMultiMenu')
+        @param key menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu'
+            or 'dirMultiMenu')
+        @type str
         @param controlled flag indicating to prepare the menu for a
             version controlled entry or a non-version controlled entry
-            (boolean)
+        @type bool
         """
         if key in self.__menus:
             self.__menus[key].setEnabled(controlled)
@@ -87,8 +92,10 @@
         Private method to reopen the project if needed and wanted.
 
         @param shouldReopen flag indicating that the project should
-            be reopened (boolean)
-        @param title title of the message box (string)
+            be reopened
+        @type bool
+        @param title title of the message box
+        @type str
         """
         if shouldReopen:
             res = EricMessageBox.yesNo(

eric ide

mercurial