src/eric7/UI/EmailDialog.py

branch
eric7
changeset 10433
328f3ec4b77a
parent 10331
c1a2ff7e3575
child 10439
21c28b0f9e41
diff -r 2fe91fe443dd -r 328f3ec4b77a src/eric7/UI/EmailDialog.py
--- a/src/eric7/UI/EmailDialog.py	Thu Dec 21 15:46:22 2023 +0100
+++ b/src/eric7/UI/EmailDialog.py	Thu Dec 21 19:50:01 2023 +0100
@@ -53,8 +53,10 @@
         """
         Constructor
 
-        @param mode mode of this dialog (string, "bug" or "feature")
-        @param parent parent widget of this dialog (QWidget)
+        @param mode mode of this dialog ("bug" or "feature")
+        @type str
+        @param parent parent widget of this dialog
+        @type QWidget
         """
         super().__init__(parent)
         self.setupUi(self)
@@ -117,7 +119,8 @@
         """
         Protected method to handle the user pressing the escape key.
 
-        @param ev key event (QKeyEvent)
+        @param ev key event
+        @type QKeyEvent
         """
         if ev.key() == Qt.Key.Key_Escape:
             res = EricMessageBox.yesNo(
@@ -132,7 +135,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.sendButton:
             self.on_sendButton_clicked()
@@ -206,8 +210,10 @@
         """
         Private method to create a MIMEText message with correct encoding.
 
-        @param txt text to be put into the MIMEText object (string)
+        @param txt text to be put into the MIMEText object
+        @type str
         @return MIMEText object
+        @rtype email.mime.text.MIMEText
         """
         try:
             txt.encode("us-ascii")
@@ -220,8 +226,10 @@
         """
         Private method to create a correctly encoded mail header.
 
-        @param txt header text to encode (string)
-        @return encoded header (email.header.Header)
+        @param txt header text to encode
+        @type str
+        @return encoded header
+        @rtype email.header.Header
         """
         try:
             txt.encode("us-ascii")
@@ -320,8 +328,10 @@
         """
         Private method to actually send the message.
 
-        @param msg the message to be sent (string)
-        @return flag indicating success (boolean)
+        @param msg the message to be sent
+        @type str
+        @return flag indicating success
+        @rtype bool
         """
         try:
             encryption = Preferences.getUser("MailServerEncryption")
@@ -464,9 +474,11 @@
         """
         Public method to add an attachment.
 
-        @param fname name of the file to be attached (string)
+        @param fname name of the file to be attached
+        @type str
         @param deleteFile flag indicating to delete the file after it has
-            been sent (boolean)
+            been sent
+        @type bool
         """
         mimeType = mimetypes.guess_type(fname)[0]
         if not mimeType:
@@ -497,7 +509,8 @@
         """
         Private slot to handle the textChanged signal of the subject edit.
 
-        @param txt changed text (string)
+        @param txt changed text
+        @type str
         """
         self.sendButton.setEnabled(
             self.subject.text() != "" and self.message.toPlainText() != ""

eric ide

mercurial