src/eric7/Plugins/VcsPlugins/vcsMercurial/HgExtensionProjectBrowserHelper.py

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 9653
e67609152c5e
child 10439
21c28b0f9e41
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgExtensionProjectBrowserHelper.py	Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgExtensionProjectBrowserHelper.py	Sat Dec 23 15:40:23 2023 +0100
@@ -26,8 +26,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__()
 
@@ -41,9 +44,9 @@
 
         Note: Derived class must implement this method.
 
-        @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
         @exception NotImplementedError raised if the class has not been
             reimplemented
         """
@@ -63,7 +66,8 @@
 
         Note: Derived class must implement this method.
 
-        @return title of the menu (string)
+        @return title of the menu
+        @rtype str
         @exception NotImplementedError raised if the class has not been
             reimplemented
         """
@@ -78,11 +82,12 @@
         Note: Derived class must implement this method to adjust the
         enabled states of its menus.
 
-        @param key menu key (string, one of 'mainMenu', 'multiMenu',
+        @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
         @exception NotImplementedError raised if the class has not been
             reimplemented
         """
@@ -92,7 +97,7 @@
         """
         Protected method to update the VCS status of an item.
 
-        @param name filename or directoryname of the item to be updated
-            (string)
+        @param name filename or directory name of the item to be updated
+        @type str
         """
         self.project.getModel().updateVCSStatus(name)

eric ide

mercurial