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

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 9653
e67609152c5e
child 10439
21c28b0f9e41
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/HgShelveBrowserDialog.py	Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/HgShelveBrowserDialog.py	Sat Dec 23 15:40:23 2023 +0100
@@ -37,7 +37,9 @@
         Constructor
 
         @param vcs reference to the vcs object
-        @param parent parent widget (QWidget)
+        @type Hg
+        @param parent parent widget
+        @type QWidget
         """
         super().__init__(parent)
         self.setupUi(self)
@@ -77,7 +79,8 @@
         """
         Protected slot implementing a close event handler.
 
-        @param e close event (QCloseEvent)
+        @param e close event
+        @type QCloseEvent
         """
         if self.__hgClient.isExecuting():
             self.__hgClient.cancel()
@@ -113,15 +116,19 @@
         """
         Private method to generate the shelve items.
 
-        @param name name of the shelve (string)
-        @param age age of the shelve (string)
-        @param message shelve message (string)
-        @param fileStatistics per file change statistics (tuple of
-            four strings with file name, number of changes, number of
-            added lines and number of deleted lines)
-        @param totals overall statistics (tuple of three strings with
-            number of changed files, number of added lines and number
-            of deleted lines)
+        @param name name of the shelve
+        @type str
+        @param age age of the shelve
+        @type str
+        @param message shelve message
+        @type str
+        @param fileStatistics per file change statistics (tuple containing the
+            file name, the number of changes, the number of added lines and the
+            number of deleted lines)
+        @type tuple of (str, str, str, str)
+        @param totals overall statistics (tuple containing the number of changed files,
+            the number of added lines and the number of deleted lines)
+        @type tuple of (str, str, str)
         """
         itm = QTreeWidgetItem(self.shelveList, [name, age, message])
         itm.setData(0, self.__fileStatisticsRole, fileStatistics)
@@ -237,7 +244,8 @@
         """
         Private slot to show some error.
 
-        @param out error to be shown (string)
+        @param out error to be shown
+        @type str
         """
         self.errorGroup.show()
         self.errors.insertPlainText(out)
@@ -248,7 +256,8 @@
         """
         Private slot called by a button of the button box clicked.
 
-        @param button button that was clicked (QAbstractButton)
+        @param button button that was clicked
+        @type QAbstractButton
         """
         if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close):
             self.close()
@@ -263,8 +272,10 @@
         """
         Private slot called, when the current item of the shelve list changes.
 
-        @param current reference to the new current item (QTreeWidgetItem)
-        @param previous reference to the old current item (QTreeWidgetItem)
+        @param current reference to the new current item
+        @type QTreeWidgetItem
+        @param previous reference to the old current item
+        @type QTreeWidgetItem
         """
         self.statisticsList.clear()
         if current:
@@ -293,7 +304,8 @@
         """
         Private slot to show the context menu of the shelve list.
 
-        @param pos position of the mouse pointer (QPoint)
+        @param pos position of the mouse pointer
+        @type QPoint
         """
         selectedItemsCount = len(self.shelveList.selectedItems())
         self.__unshelveAct.setEnabled(selectedItemsCount == 1)

eric ide

mercurial