src/eric7/Plugins/VcsPlugins/vcsGit/GitDiffDialog.py

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 9653
e67609152c5e
child 10439
21c28b0f9e41
--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitDiffDialog.py	Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitDiffDialog.py	Sat Dec 23 15:40:23 2023 +0100
@@ -36,7 +36,9 @@
         Constructor
 
         @param vcs reference to the vcs object
-        @param parent parent widget (QWidget)
+        @type Git
+        @param parent parent widget
+        @type QWidget
         """
         super().__init__(parent)
         self.setupUi(self)
@@ -94,7 +96,8 @@
         """
         Protected slot implementing a close event handler.
 
-        @param e close event (QCloseEvent)
+        @param e close event
+        @type QCloseEvent
         """
         self.__diffGenerator.stopProcesses()
         e.accept()
@@ -105,9 +108,10 @@
         """
         Public slot to start the git diff command.
 
-        @param fn filename to be diffed (string)
-        @param versions list of versions to be diffed (list of up to 2 strings
-            or None)
+        @param fn filename to be diffed
+        @type str
+        @param versions list of versions to be diffed
+        @type list of up to 2 str or None
         @param diffMode indication for the type of diff to be performed (
             'work2repo' compares the working tree with the HEAD commit,
             'work2stage' compares the working tree with the staging area,
@@ -115,8 +119,11 @@
             'work2stage2repo' compares the working tree with the staging area
                 and the staging area with the HEAD commit,
             'stash' shows the diff for a stash)
-        @param stashName name of the stash to show a diff for (string)
-        @param refreshable flag indicating a refreshable diff (boolean)
+        @type str
+        @param stashName name of the stash to show a diff for
+        @type str
+        @param refreshable flag indicating a refreshable diff
+        @type bool
         @exception ValueError raised to indicate a bad value for the 'diffMode'
             parameter.
         """
@@ -230,7 +237,9 @@
         Private method to merge the file separator entries.
 
         @param fileSeparators list of file separator entries to be merged
+        @type list of str
         @return merged list of file separator entries
+        @rtype list of str
         """
         separators = {}
         for oldFile, newFile, pos1, pos2 in sorted(fileSeparators):
@@ -247,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.Save):
             self.on_saveButton_clicked()
@@ -259,7 +269,8 @@
         """
         Private slot to handle the selection of a file.
 
-        @param index activated row (integer)
+        @param index activated row
+        @type int
         """
         para1, para2 = self.filesCombo.itemData(index)
 

eric ide

mercurial