--- a/src/eric7/Plugins/VcsPlugins/vcsGit/GitDialog.py Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Plugins/VcsPlugins/vcsGit/GitDialog.py Sat Dec 23 15:40:23 2023 +0100
@@ -39,9 +39,12 @@
"""
Constructor
- @param text text to be shown by the label (string)
- @param git reference to the Git interface object (Git)
- @param parent parent widget (QWidget)
+ @param text text to be shown by the label
+ @type str
+ @param git reference to the Git interface object
+ @type Git
+ @param parent parent widget
+ @type QWidget
"""
super().__init__(parent)
self.setupUi(self)
@@ -98,7 +101,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()
@@ -110,8 +114,10 @@
"""
Private slot connected to the finished signal.
- @param exitCode exit code of the process (integer)
- @param exitStatus exit status of the process (QProcess.ExitStatus)
+ @param exitCode exit code of the process
+ @type int
+ @param exitStatus exit status of the process
+ @type QProcess.ExitStatus
"""
self.normal = (exitStatus == QProcess.ExitStatus.NormalExit) and (exitCode == 0)
if self.normal:
@@ -128,12 +134,17 @@
"""
Public slot used to start the process.
- @param args list of arguments for the process (list of strings)
- @param workingDir working directory for the process (string)
- @param showArgs flag indicating to show the arguments (boolean)
+ @param args list of arguments for the process
+ @type list of str
+ @param workingDir working directory for the process
+ @type str
+ @param showArgs flag indicating to show the arguments
+ @type bool
@param environment dictionary of environment settings to add
- or change for the git process (dict of string and string)
- @return flag indicating a successful start of the process (boolean)
+ or change for the git process
+ @type dict
+ @return flag indicating a successful start of the process
+ @rtype bool
"""
self.errorGroup.hide()
self.normal = False
@@ -196,7 +207,8 @@
"""
Public method to check for a normal process termination.
- @return flag indicating normal process termination (boolean)
+ @return flag indicating normal process termination
+ @rtype bool
"""
return self.normal
@@ -205,7 +217,8 @@
Public method to check for a normal process termination without
error messages.
- @return flag indicating normal process termination (boolean)
+ @return flag indicating normal process termination
+ @rtype bool
"""
return self.normal and self.errors.toPlainText() == ""
@@ -228,7 +241,8 @@
"""
Private slot to show some output.
- @param out output to be shown (string)
+ @param out output to be shown
+ @type str
"""
self.resultbox.insertPlainText(out)
self.resultbox.ensureCursorVisible()
@@ -261,7 +275,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)
@@ -273,7 +288,8 @@
"""
Private slot to handle the password checkbox toggled.
- @param isOn flag indicating the status of the check box (boolean)
+ @param isOn flag indicating the status of the check box
+ @type bool
"""
if isOn:
self.input.setEchoMode(QLineEdit.EchoMode.Password)
@@ -311,7 +327,8 @@
"""
Protected slot to handle a key press event.
- @param evt the key press event (QKeyEvent)
+ @param evt the key press event
+ @type QKeyEvent
"""
if self.intercept:
self.intercept = False
@@ -323,6 +340,7 @@
"""
Public method to check, if the last action contained an add or delete.
- @return flag indicating the presence of an add or delete (boolean)
+ @return flag indicating the presence of an add or delete
+ @rtype bool
"""
return self.__hasAddOrDelete
