src/eric7/VCS/ProjectHelper.py

branch
eric7
changeset 10436
f6881d10e995
parent 10403
ea3320d5e8e9
child 10439
21c28b0f9e41
diff -r c712d09cc839 -r f6881d10e995 src/eric7/VCS/ProjectHelper.py
--- a/src/eric7/VCS/ProjectHelper.py	Fri Dec 22 13:57:47 2023 +0100
+++ b/src/eric7/VCS/ProjectHelper.py	Fri Dec 22 17:24:07 2023 +0100
@@ -35,9 +35,13 @@
         Constructor
 
         @param vcsObject reference to the vcs object
+        @type VersionControl
         @param projectObject reference to the project object
-        @param parent parent widget (QWidget)
-        @param name name of this object (string)
+        @type Project
+        @param parent parent widget
+        @type QWidget
+        @param name name of this object
+        @type str
         """
         super().__init__(parent)
         if name:
@@ -57,7 +61,9 @@
         Public method to set references to the vcs and project objects.
 
         @param vcsObject reference to the vcs object
+        @type VersionControl
         @param projectObject reference to the project object
+        @type Project
         """
         self.vcs = vcsObject
         self.project = projectObject
@@ -146,7 +152,8 @@
         """
         Public method to generate the VCS menu.
 
-        @param menu reference to the menu to be populated (QMenu)
+        @param menu reference to the menu to be populated
+        @type QMenu
         """
         menu.clear()
 
@@ -160,10 +167,12 @@
         """
         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)
-        @return the toolbar generated (QToolBar)
+        @type EricToolBarManager
+        @return the toolbar generated
+        @rtype QToolBar
         """
         return None  # __IGNORE_WARNING_M831__
 
@@ -171,10 +180,12 @@
         """
         Public slot to initialize the basic 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)
-        @return the toolbar generated (QToolBar)
+        @type EricToolBarManager
+        @return the toolbar generated
+        @rtype QToolBar
         """
         tb = QToolBar(QCoreApplication.translate("VcsProjectHelper", "VCS"), ui)
         tb.setObjectName("VersionControlToolbar")
@@ -202,7 +213,8 @@
         Protected slot used to create a local project from the repository.
 
         @param export flag indicating whether an export or a checkout
-                should be performed
+            should be performed
+        @type bool
         """
         if not self.project or not self.project.checkDirty():
             return

eric ide

mercurial