Mercurial Repositories > eric / file diff

diff -r bbf3af40c223 -r b31f0d894b55 eric7/Plugins/UiExtensionPlugins/Translator/TranslatorEngines/TranslationEngine.py
--- a/eric7/Plugins/UiExtensionPlugins/Translator/TranslatorEngines/TranslationEngine.py	Sun Jun 12 16:05:27 2022 +0200
+++ b/eric7/Plugins/UiExtensionPlugins/Translator/TranslatorEngines/TranslationEngine.py	Mon Jun 13 16:39:53 2022 +0200
@@ -26,8 +26,10 @@
         """
         Constructor
         
-        @param plugin reference to the plugin object (TranslatorPlugin)
-        @param parent reference to the parent object (QObject)
+        @param plugin reference to the plugin object
+        @type TranslatorPlugin
+        @param parent reference to the parent object
+        @type QObject
         """
         super().__init__(parent)
         
@@ -37,7 +39,8 @@
         """
         Public method to get the name of the engine.
         
-        @return engine name (string)
+        @return engine name
+        @rtype str
         """
         return ""
     
@@ -45,7 +48,8 @@
         """
         Public method to get the supported languages.
         
-        @return list of supported language codes (list of string)
+        @return list of supported language codes
+        @rtype list of str
         """
         return []
     
@@ -73,7 +77,8 @@
         """
         Public method indicating the Text-to-Speech capability.
         
-        @return flag indicating the Text-to-Speech capability (boolean)
+        @return flag indicating the Text-to-Speech capability
+        @rtype bool
         """
         return False
     
@@ -82,11 +87,13 @@
         Public method to pronounce the given text.
         
         @param requestObject reference to the request object
-            (TranslatorRequest)
-        @param text text to be pronounced (string)
-        @param language language code of the text (string)
-        @return tuple with pronounce data (QByteArray) or error string (string)
-            and success flag (boolean)
+        @type TranslatorRequest
+        @param text text to be pronounced
+        @type str
+        @param language language code of the text
+        @type str
+        @return tuple with pronounce data or an error string and a success flag
+        @rtype tuple of (QByteArray or str, bool)
         """
         return self.tr("No pronounce data available"), False
     
@@ -96,11 +103,14 @@
         Public method to translate the given text.
         
         @param requestObject reference to the request object
-            (TranslatorRequest)
-        @param text text to be translated (string)
-        @param originalLanguage language code of the original (string)
-        @param translationLanguage language code of the translation (string)
-        @return tuple of translated text (string) and flag indicating
-            success (boolean)
+        @type TranslatorRequest
+        @param text text to be translated
+        @type str
+        @param originalLanguage language code of the original
+        @type str
+        @param translationLanguage language code of the translation
+        @type str
+        @return tuple of translated text and flag indicating success
+        @rtype tuple of (str, bool)
         """
         return self.tr("No translation available"), False