Mercurial Repositories > eric / file diff

--- a/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.TranslationEngine.html	Sun Jun 12 16:05:27 2022 +0200
+++ b/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.TranslationEngine.html	Mon Jun 13 16:39:53 2022 +0200
@@ -108,13 +108,13 @@
 </p>
 <dl>
 
-<dt><i>plugin</i></dt>
+<dt><i>plugin</i> (TranslatorPlugin)</dt>
 <dd>
-reference to the plugin object (TranslatorPlugin)
+reference to the plugin object
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QObject)</dt>
 <dd>
-reference to the parent object (QObject)
+reference to the parent object
 </dd>
 </dl>
 <a NAME="TranslationEngine.engineName" ID="TranslationEngine.engineName"></a>
@@ -127,7 +127,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-engine name (string)
+engine name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="TranslationEngine.getTextToSpeechData" ID="TranslationEngine.getTextToSpeechData"></a>
@@ -139,25 +145,29 @@
 </p>
 <dl>
 
-<dt><i>requestObject</i></dt>
+<dt><i>requestObject</i> (TranslatorRequest)</dt>
 <dd>
 reference to the request object
-            (TranslatorRequest)
 </dd>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-text to be pronounced (string)
+text to be pronounced
 </dd>
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
-language code of the text (string)
+language code of the text
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple with pronounce data (QByteArray) or error string (string)
-            and success flag (boolean)
+tuple with pronounce data or an error string and a success flag
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (QByteArray or str, bool)
 </dd>
 </dl>
 <a NAME="TranslationEngine.getTranslation" ID="TranslationEngine.getTranslation"></a>
@@ -169,29 +179,33 @@
 </p>
 <dl>
 
-<dt><i>requestObject</i></dt>
+<dt><i>requestObject</i> (TranslatorRequest)</dt>
 <dd>
 reference to the request object
-            (TranslatorRequest)
 </dd>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-text to be translated (string)
+text to be translated
 </dd>
-<dt><i>originalLanguage</i></dt>
+<dt><i>originalLanguage</i> (str)</dt>
 <dd>
-language code of the original (string)
+language code of the original
 </dd>
-<dt><i>translationLanguage</i></dt>
+<dt><i>translationLanguage</i> (str)</dt>
 <dd>
-language code of the translation (string)
+language code of the translation
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple of translated text (string) and flag indicating
-            success (boolean)
+tuple of translated text and flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, bool)
 </dd>
 </dl>
 <a NAME="TranslationEngine.hasTTS" ID="TranslationEngine.hasTTS"></a>
@@ -204,7 +218,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating the Text-to-Speech capability (boolean)
+flag indicating the Text-to-Speech capability
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="TranslationEngine.supportedLanguages" ID="TranslationEngine.supportedLanguages"></a>
@@ -217,7 +237,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of supported language codes (list of string)
+list of supported language codes
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="TranslationEngine.supportedTargetLanguages" ID="TranslationEngine.supportedTargetLanguages"></a>