src/eric7/UI/DiffDialog.py

branch
eric7
changeset 10433
328f3ec4b77a
parent 10303
ee1aadab1215
child 10439
21c28b0f9e41
diff -r 2fe91fe443dd -r 328f3ec4b77a src/eric7/UI/DiffDialog.py
--- a/src/eric7/UI/DiffDialog.py	Thu Dec 21 15:46:22 2023 +0100
+++ b/src/eric7/UI/DiffDialog.py	Thu Dec 21 19:50:01 2023 +0100
@@ -38,7 +38,7 @@
         Constructor
 
         @param files list of two file names to be diffed
-        @type list of two str
+        @type list of [str, str]
         @param parent reference to the parent widget
         @type QWidget
         """
@@ -87,7 +87,8 @@
         """
         Public slot to show the dialog.
 
-        @param filename name of a file to use as the first file (string)
+        @param filename name of a file to use as the first file
+        @type str
         """
         if filename:
             self.file1Picker.setText(filename)
@@ -97,7 +98,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.diffButton:
             self.on_diffButton_clicked()
@@ -225,7 +227,8 @@
         """
         Private method to append text to the end of the contents pane.
 
-        @param txt text to insert (string)
+        @param txt text to insert
+        @type str
         """
         tc = self.contents.textCursor()
         tc.movePosition(QTextCursor.MoveOperation.End)
@@ -236,12 +239,18 @@
         """
         Private slot to generate a unified diff output.
 
-        @param a first sequence of lines (list of strings)
-        @param b second sequence of lines (list of strings)
-        @param fromfile filename of the first file (string)
-        @param tofile filename of the second file (string)
-        @param fromfiledate modification time of the first file (string)
-        @param tofiledate modification time of the second file (string)
+        @param a first sequence of lines
+        @type list of str
+        @param b second sequence of lines
+        @type list of str
+        @param fromfile filename of the first file
+        @type str
+        @param tofile filename of the second file
+        @type str
+        @param fromfiledate modification time of the first file
+        @type str
+        @param tofiledate modification time of the second file
+        @type str
         """
         for paras, line in enumerate(
             unified_diff(a, b, fromfile, tofile, fromfiledate, tofiledate)
@@ -257,12 +266,18 @@
         """
         Private slot to generate a context diff output.
 
-        @param a first sequence of lines (list of strings)
-        @param b second sequence of lines (list of strings)
-        @param fromfile filename of the first file (string)
-        @param tofile filename of the second file (string)
-        @param fromfiledate modification time of the first file (string)
-        @param tofiledate modification time of the second file (string)
+        @param a first sequence of lines
+        @type list of str
+        @param b second sequence of lines
+        @type list of str
+        @param fromfile filename of the first file
+        @type str
+        @param tofile filename of the second file
+        @type str
+        @param fromfiledate modification time of the first file
+        @type str
+        @param tofiledate modification time of the second file
+        @type str
         """
         for paras, line in enumerate(
             context_diff(a, b, fromfile, tofile, fromfiledate, tofiledate)
@@ -294,7 +309,7 @@
         Constructor
 
         @param files list of two file names to be diffed
-        @type list of two str
+        @type list of [str, str]
         @param parent reference to the parent widget
         @type QWidget
         """
@@ -312,9 +327,12 @@
         """
         Public method to filter events.
 
-        @param obj reference to the object the event is meant for (QObject)
-        @param event reference to the event object (QEvent)
-        @return flag indicating, whether the event was handled (boolean)
+        @param obj reference to the object the event is meant for
+        @type QObject
+        @param event reference to the event object
+        @type QEvent
+        @return flag indicating, whether the event was handled
+        @rtype bool
         """
         if event.type() == QEvent.Type.Close:
             QApplication.exit()

eric ide

mercurial