src/eric7/UI/LogView.py

branch
eric7
changeset 10433
328f3ec4b77a
parent 9653
e67609152c5e
child 10439
21c28b0f9e41
--- a/src/eric7/UI/LogView.py	Thu Dec 21 15:46:22 2023 +0100
+++ b/src/eric7/UI/LogView.py	Thu Dec 21 19:50:01 2023 +0100
@@ -34,8 +34,10 @@
         """
         Constructor
 
-        @param ui reference to the main window (UserInterface)
-        @param parent reference to the parent widget (QWidget)
+        @param ui reference to the main window
+        @type UserInterface
+        @param parent reference to the parent widget
+        @type QWidget
         """
         super().__init__(parent)
 
@@ -65,7 +67,8 @@
         """
         Public slot to appand text to the "stdout" tab.
 
-        @param txt text to be appended (string)
+        @param txt text to be appended
+        @type str
         """
         added = self.__logViewer.appendToStdout(txt)
         if added:
@@ -75,7 +78,8 @@
         """
         Public slot to appand text to the "stderr" tab.
 
-        @param txt text to be appended (string)
+        @param txt text to be appended
+        @type str
         """
         added = self.__logViewer.appendToStderr(txt)
         if added:
@@ -91,7 +95,8 @@
         """
         Public method to display the search widget.
 
-        @param txt text to be shown in the combo (string)
+        @param txt text to be shown in the combo
+        @type str
         """
         self.__searchWidget.showFind(txt)
 
@@ -110,7 +115,8 @@
         """
         Constructor
 
-        @param parent reference to the parent widget (QWidget)
+        @param parent reference to the parent widget
+        @type QWidget
         """
         super().__init__(parent)
         self.setAcceptRichText(False)
@@ -146,7 +152,8 @@
         """
         Private slot to show the context menu.
 
-        @param coord the position of the mouse pointer (QPoint)
+        @param coord the position of the mouse pointer
+        @type QPoint
         """
         coord = self.mapToGlobal(coord)
         self.__menu.popup(coord)
@@ -155,8 +162,10 @@
         """
         Private method to append text to the end.
 
-        @param txt text to insert (string)
-        @param isErrorMessage flag indicating to insert error text (boolean)
+        @param txt text to insert
+        @type str
+        @param isErrorMessage flag indicating to insert error text
+        @type bool
         """
         tc = self.textCursor()
         tc.movePosition(QTextCursor.MoveOperation.End)
@@ -172,11 +181,12 @@
         """
         Private method to filter messages.
 
-        @param message message to be checked (string)
+        @param message message to be checked
+        @type str
         @param isErrorMessage flag indicating to check an error message
-            (boolean)
+        @type bool
         @return flag indicating that the message should be filtered out
-            (boolean)
+        @rtype bool
         """
         message = Utilities.filterAnsiSequences(message)
 
@@ -190,10 +200,12 @@
 
     def appendToStdout(self, txt):
         """
-        Public slot to appand text to the "stdout" tab.
+        Public slot to append text to the "stdout" tab.
 
-        @param txt text to be appended (string)
-        @return flag indicating text was appended (boolean)
+        @param txt text to be appended
+        @type str
+        @return flag indicating text was appended
+        @rtype bool
         """
         if self.__filterMessage(txt, isErrorMessage=False):
             return False
@@ -204,10 +216,12 @@
 
     def appendToStderr(self, txt):
         """
-        Public slot to appand text to the "stderr" tab.
+        Public slot to append text to the "stderr" tab.
 
-        @param txt text to be appended (string)
-        @return flag indicating text was appended (boolean)
+        @param txt text to be appended
+        @type str
+        @return flag indicating text was appended
+        @rtype bool
         """
         if self.__filterMessage(txt, isErrorMessage=True):
             return False
@@ -245,11 +259,9 @@
 
         @param txt text to search for
         @type str
-        @param caseSensitive flag indicating to perform a case sensitive
-            search
+        @param caseSensitive flag indicating to perform a case sensitive search
         @type bool
-        @param wholeWord flag indicating to search for whole words
-            only
+        @param wholeWord flag indicating to search for whole words only
         @type bool
         @param regexp flag indicating a regular expression search
         @type bool
@@ -281,11 +293,9 @@
 
         @param txt text to search for
         @type str
-        @param caseSensitive flag indicating to perform a case sensitive
-            search
+        @param caseSensitive flag indicating to perform a case sensitive search
         @type bool
-        @param wholeWord flag indicating to search for whole words
-            only
+        @param wholeWord flag indicating to search for whole words only
         @type bool
         @param regexp flag indicating a regular expression search
         @type bool
@@ -315,7 +325,8 @@
         """
         Protected method handling key press events.
 
-        @param evt key press event (QKeyEvent)
+        @param evt key press event
+        @type QKeyEvent
         """
         if evt.modifiers() == Qt.KeyboardModifier.ControlModifier:
             if evt.key() == Qt.Key.Key_F:

eric ide

mercurial