eric: comparison src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnLogBrowserDialog.py

-:2f70ca07f0af
+:4cd7e5a8b3cf
 def __init__(self, vcs, parent=None):
 """
 Constructor
 @param vcs reference to the vcs object
-@param parent parent widget (QWidget)
+@type Subversion
+@param parent parent widget
+@type QWidget
 """
 super().__init__(parent)
 self.setupUi(self)
 self.__position = QPoint()
 def closeEvent(self, e):
 """
 Protected slot implementing a close event handler.
-@param e close event (QCloseEvent)
+@param e close event
+@type QCloseEvent
 """
 if (
 self.__process is not None
 and self.__process.state() != QProcess.ProcessState.NotRunning
 ):
 def __generateLogItem(self, author, date, message, revision, changedPaths):
 """
 Private method to generate a log tree entry.
-@param author author info (string)
+@param author author info
-@param date date info (string)
+@type str
-@param message text of the log message (list of strings)
+@param date date info
-@param revision revision info (string)
+@type str
+@param message text of the log message
+@type list of str
+@param revision revision info
+@type str
 @param changedPaths list of dictionary objects containing
 info about the changed files/directories
-@return reference to the generated item (QTreeWidgetItem)
+@type dict
+@return reference to the generated item
+@rtype QTreeWidgetItem
 """
 msg = []
 for line in message:
 msg.append(line.strip())
 def __generateFileItem(self, action, path, copyFrom, copyRev):
 """
 Private method to generate a changed files tree entry.
 @param action indicator for the change action ("A", "D" or "M")
-@param path path of the file in the repository (string)
+@type str
-@param copyFrom path the file was copied from (None, string)
+@param path path of the file in the repository
-@param copyRev revision the file was copied from (None, string)
+@type str
-@return reference to the generated item (QTreeWidgetItem)
+@param copyFrom path the file was copied from
+@type str
+@param copyRev revision the file was copied from
+@type str
+@return reference to the generated item
+@rtype QTreeWidgetItem
 """
 itm = QTreeWidgetItem(
 self.filesTree,
 [
 self.flags[action],
 def __getLogEntries(self, startRev=None):
 """
 Private method to retrieve log entries from the repository.
-@param startRev revision number to start from (integer, string)
+@param startRev revision number to start from
+@type int or str
 """
 self.buttonBox.button(QDialogButtonBox.StandardButton.Close).setEnabled(False)
 self.buttonBox.button(QDialogButtonBox.StandardButton.Cancel).setEnabled(True)
 self.buttonBox.button(QDialogButtonBox.StandardButton.Cancel).setDefault(True)
 QApplication.processEvents()
 def start(self, fn, isFile=False):
 """
 Public slot to start the svn log command.
-@param fn filename to show the log for (string)
+@param fn filename to show the log for
+@type str
 @param isFile flag indicating log for a file is to be shown
-(boolean)
+@type bool
 """
 self.sbsCheckBox.setEnabled(isFile)
 self.sbsCheckBox.setVisible(isFile)
 self.errorGroup.hide()
 @pyqtSlot(int, QProcess.ExitStatus)
 def __procFinished(self, exitCode, exitStatus):
 """
 Private slot connected to the finished signal.
-@param exitCode exit code of the process (integer)
+@param exitCode exit code of the process
-@param exitStatus exit status of the process (QProcess.ExitStatus)
+@type int
+@param exitStatus exit status of the process
+@type QProcess.ExitStatus
 """
 self.__processBuffer()
 self.__finish()
 def __finish(self):
 def __diffRevisions(self, rev1, rev2):
 """
 Private method to do a diff of two revisions.
-@param rev1 first revision number (integer)
+@param rev1 first revision number
-@param rev2 second revision number (integer)
+@type int
+@param rev2 second revision number
+@type int
 """
 from .SvnDiffDialog import SvnDiffDialog
 if self.sbsCheckBox.isEnabled() and self.sbsCheckBox.isChecked():
 self.vcs.vcsSbsDiff(self.filename, revisions=(str(rev1), str(rev2)))
 def on_buttonBox_clicked(self, button):
 """
 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()
 elif button == self.buttonBox.button(QDialogButtonBox.StandardButton.Cancel):
 self.cancelled = True
 @pyqtSlot(QTreeWidgetItem, QTreeWidgetItem)
 def on_logTree_currentItemChanged(self, current, previous):
 """
 Private slot called, when the current item of the log tree changes.
-@param current reference to the new current item (QTreeWidgetItem)
+@param current reference to the new current item
-@param previous reference to the old current item (QTreeWidgetItem)
+@type QTreeWidgetItem
+@param previous reference to the old current item
+@type QTreeWidgetItem
 """
 if current is not None:
 self.messageEdit.clear()
 for line in current.data(0, self.__messageRole):
 self.messageEdit.append(line.strip())
 @pyqtSlot(QDate)
 def on_fromDate_dateChanged(self, date):
 """
 Private slot called, when the from date changes.
-@param date new date (QDate)
+@param date new date
+@type QDate
 """
 self.__filterLogs()
 @pyqtSlot(QDate)
 def on_toDate_dateChanged(self, date):
 """
 Private slot called, when the from date changes.
-@param date new date (QDate)
+@param date new date
+@type QDate
 """
 self.__filterLogs()
 @pyqtSlot(int)
 def on_fieldCombo_activated(self, index):
 @pyqtSlot(str)
 def on_rxEdit_textChanged(self, txt):
 """
 Private slot called, when a filter expression is entered.
-@param txt filter expression (string)
+@param txt filter expression
+@type str
 """
 self.__filterLogs()
 def __filterLogs(self):
 """
 @pyqtSlot(bool)
 def on_stopCheckBox_clicked(self, checked):
 """
 Private slot called, when the stop on copy/move checkbox is clicked.
-@param checked flag indicating the checked state (boolean)
+@param checked flag indicating the checked state
+@type bool
 """
 self.vcs.getPlugin().setPreferences(
 "StopLogOnCopy", self.stopCheckBox.isChecked()
 )
 self.nextButton.setEnabled(True)
 def on_passwordCheckBox_toggled(self, isOn):
 """
 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)
 else:
 self.input.setEchoMode(QLineEdit.EchoMode.Normal)
 def keyPressEvent(self, evt):
 """
 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
 evt.accept()
 return

Mercurial Repositories > eric / file comparison

comparison: src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnLogBrowserDialog.py

src/eric7/Plugins/VcsPlugins/vcsSubversion/SvnLogBrowserDialog.py