From 480314307534d623323f64f14e6838b73377ed17 Mon Sep 17 00:00:00 2001 From: "sooyeon.kim" Date: Mon, 28 Aug 2017 18:29:34 +0900 Subject: [PATCH] [STT/TTS] Fix spelling errors and Add descriptions Change-Id: I5b251f9f1741190a3fc39b8cd4d745904ffa44fa Signed-off-by: sooyeon.kim --- .../Tizen.Uix.SttEngine/SttEngine.cs | 40 ++++++++++++++++++---- .../Tizen.Uix.TtsEngine/TtsEngine.cs | 28 +++++++++++++-- 2 files changed, 60 insertions(+), 8 deletions(-) diff --git a/src/Tizen.Uix.SttEngine/Tizen.Uix.SttEngine/SttEngine.cs b/src/Tizen.Uix.SttEngine/Tizen.Uix.SttEngine/SttEngine.cs index 219c3c2..77f0965 100755 --- a/src/Tizen.Uix.SttEngine/Tizen.Uix.SttEngine/SttEngine.cs +++ b/src/Tizen.Uix.SttEngine/Tizen.Uix.SttEngine/SttEngine.cs @@ -219,7 +219,7 @@ namespace Tizen.Uix.SttEngine /// The result text /// The time started speaking the result text /// The time finished speaking the result text - /// The User data + /// The User data /// true to continue with the next iteration of the loop, false to break out of the loop /// SendResult() should be called. public delegate bool ResultTime(int index, TimeEvent resultEvent, string text, long startTime, long endTime, IntPtr userData); @@ -231,7 +231,7 @@ namespace Tizen.Uix.SttEngine /// The language is specified as an ISO 3166 alpha-2 two letter country-code /// followed by ISO 639-1 for the two-letter language code /// for example, "ko_KR" for Korean, "en_US" for American English - /// The User data + /// The User data /// true to continue with the next iteration of the loop, false to break out of the loop /// ForEachSupportedLanguages() should be called public delegate bool SupportedLanguages(string language, IntPtr userData); @@ -442,8 +442,8 @@ namespace Tizen.Uix.SttEngine /// 3. InvalidParameter /// 4. OperationFailed /// - /// - /// Start should succeed + /// + /// Start should succeed /// /// If the engine supports partial result, SendResult() should be invoked. public abstract Error SetRecordingData(string data, uint length); @@ -458,8 +458,8 @@ namespace Tizen.Uix.SttEngine /// 3. OperationFailed /// 4. NetworkDown /// - /// - /// Start should succeed + /// + /// Start should succeed /// /// After processing of the engine, , SendResult() should be invoked. public abstract Error Stop(); @@ -479,6 +479,10 @@ namespace Tizen.Uix.SttEngine /// /// Public Constructor /// + /// + /// http://tizen.org/feature/speech.recognition + /// http://tizen.org/feature/microphone + /// public Engine() { _engine = this; @@ -491,6 +495,10 @@ namespace Tizen.Uix.SttEngine /// /// http://tizen.org/privilege/recorder /// + /// + /// http://tizen.org/feature/speech.recognition + /// http://tizen.org/feature/microphone + /// /// /// ServiceAppMain should be used for working the engine after this function. /// @@ -534,6 +542,10 @@ namespace Tizen.Uix.SttEngine /// /// Sends the recognition result to the engine service user. /// + /// + /// http://tizen.org/feature/speech.recognition + /// http://tizen.org/feature/microphone + /// /// /// This API is used in SetRecordingData() and Stop(), when Stt engine sends the recognition result to the engine service user. /// This function is called in the following situations; 1) after Stop() is called, 2) the end point of speech is detected from recording, or 3) partial result is occurred. @@ -610,6 +622,10 @@ namespace Tizen.Uix.SttEngine /// /// Sends the error to the engine service user. /// + /// + /// http://tizen.org/feature/speech.recognition + /// http://tizen.org/feature/microphone + /// /// The Error Reason /// The error message /// Thrown in case of Invalid Parameter @@ -633,6 +649,10 @@ namespace Tizen.Uix.SttEngine /// /// Sends the speech status to the engine service user when Stt engine notifies the change of the speech status. /// + /// + /// http://tizen.org/feature/speech.recognition + /// http://tizen.org/feature/microphone + /// /// /// This API is invoked when Stt engine wants to notify the change of the speech status anytime. NOTE that this API can be invoked for recognizing the speech. /// @@ -661,6 +681,10 @@ namespace Tizen.Uix.SttEngine /// /// http://tizen.org/privilege/recorder /// + /// + /// http://tizen.org/feature/speech.recognition + /// http://tizen.org/feature/microphone + /// /// /// Called when Stt engine receives the private data from the engine service user. /// This callback function is called when the engine service user sends the private data to Stt engine. @@ -701,6 +725,10 @@ namespace Tizen.Uix.SttEngine /// /// http://tizen.org/privilege/recorder /// + /// + /// http://tizen.org/feature/speech.recognition + /// http://tizen.org/feature/microphone + /// /// callback function /// Called when Stt engine provides the engine service user with the private data. /// This callback function is called when the engine service user gets the private data from Stt engine. diff --git a/src/Tizen.Uix.TtsEngine/Tizen.Uix.TtsEngine/TtsEngine.cs b/src/Tizen.Uix.TtsEngine/Tizen.Uix.TtsEngine/TtsEngine.cs index d568e7a..e957b74 100755 --- a/src/Tizen.Uix.TtsEngine/Tizen.Uix.TtsEngine/TtsEngine.cs +++ b/src/Tizen.Uix.TtsEngine/Tizen.Uix.TtsEngine/TtsEngine.cs @@ -362,14 +362,17 @@ namespace Tizen.Uix.TtsEngine /// 1. None /// 2. InvalidState /// - /// + /// /// StartSynthesis should be performed - /// + /// public abstract Error CancelSynthesis(); /// /// Public Constructor /// + /// + /// http://tizen.org/feature/speech.synthesis + /// public Engine() { _engine = this; @@ -379,6 +382,9 @@ namespace Tizen.Uix.TtsEngine /// Main function for Text-To-Speech (TTS) engine. /// This function is the main function for operating TTS engine. /// + /// + /// http://tizen.org/feature/speech.synthesis + /// /// /// ServiceAppMain should be used for working the engine after this function. /// @@ -417,6 +423,9 @@ namespace Tizen.Uix.TtsEngine /// /// Gets the speed range from Tizen platform /// + /// + /// http://tizen.org/feature/speech.synthesis + /// /// /// This API is used when TTS engine wants to get the speed range from Tizen platform /// @@ -439,6 +448,9 @@ namespace Tizen.Uix.TtsEngine /// /// Gets the pitch range from Tizen platform. /// + /// + /// http://tizen.org/feature/speech.synthesis + /// /// /// This API is used when TTS engine wants to get the pitch range from Tizen platform. /// @@ -461,6 +473,9 @@ namespace Tizen.Uix.TtsEngine /// /// Sends the synthesized result to the engine service user. /// + /// + /// http://tizen.org/feature/speech.synthesis + /// /// /// This API is used in StartSynthesis(), when TTS engine sends the synthesized result to the engine service user. /// The synthesized result must be transferred to the engine service user through this function. @@ -489,6 +504,9 @@ namespace Tizen.Uix.TtsEngine /// /// Sends the error to the engine service user. /// + /// + /// http://tizen.org/feature/speech.synthesis + /// /// The error reason /// The error message /// @@ -508,6 +526,9 @@ namespace Tizen.Uix.TtsEngine /// /// Sets a callback function for setting the private data. /// + /// + /// http://tizen.org/feature/speech.synthesis + /// /// /// Called when the engine service user gets the private data from Tts engine. /// In Parameters: @@ -545,6 +566,9 @@ namespace Tizen.Uix.TtsEngine /// /// Sets a callback function for setting the private data. /// + /// + /// http://tizen.org/feature/speech.synthesis + /// /// callback function /// Called when TTS engine receives the private data from the engine service user. /// This callback function is called when the engine service user sends the private data to TTS engine. -- 2.7.4