From 1d98e38420f1709d15da6f4c30f2a7d7d77aa673 Mon Sep 17 00:00:00 2001 From: Editor Lionbridge Date: Wed, 26 Jul 2017 11:31:48 +0530 Subject: [PATCH] Review UIX-STT API cs files PS1: Edited summary tag and added closing bracket PS4: Edited EngineChangedEventArgs and SttClient API cs files Change-Id: Ia52e1dda02918c090cb50c2b47cbe21c1d453ece --- Tizen.Uix.Stt/Interop/Interop.Libraries.cs | 4 +- Tizen.Uix.Stt/Interop/Interop.Stt.cs | 4 +- .../DefaultLanguageChangedEventArgs.cs | 6 +- .../Tizen.Uix.Stt/EngineChangedEventArgs.cs | 10 +- .../Tizen.Uix.Stt/ErrorOccurredEventArgs.cs | 6 +- .../Tizen.Uix.Stt/RecognitionResultEventArgs.cs | 8 +- Tizen.Uix.Stt/Tizen.Uix.Stt/ResultTime.cs | 12 +- .../Tizen.Uix.Stt/StateChangedEventArgs.cs | 6 +- Tizen.Uix.Stt/Tizen.Uix.Stt/SttClient.cs | 412 ++++++++++----------- Tizen.Uix.Stt/Tizen.Uix.Stt/SupportedEngine.cs | 10 +- 10 files changed, 239 insertions(+), 239 deletions(-) diff --git a/Tizen.Uix.Stt/Interop/Interop.Libraries.cs b/Tizen.Uix.Stt/Interop/Interop.Libraries.cs index 52501fb..a4bafe2 100755 --- a/Tizen.Uix.Stt/Interop/Interop.Libraries.cs +++ b/Tizen.Uix.Stt/Interop/Interop.Libraries.cs @@ -16,12 +16,12 @@ /// -/// Partial Interop Class +/// Partial interop class. /// internal static partial class Interop { /// - /// Partial Libraries Class + /// Partial libraries class. /// internal static partial class Libraries { diff --git a/Tizen.Uix.Stt/Interop/Interop.Stt.cs b/Tizen.Uix.Stt/Interop/Interop.Stt.cs index cbf6f0d..f29291c 100755 --- a/Tizen.Uix.Stt/Interop/Interop.Stt.cs +++ b/Tizen.Uix.Stt/Interop/Interop.Stt.cs @@ -19,12 +19,12 @@ using System; using System.Runtime.InteropServices; /// -/// Partial Interop Class +/// Partial interop class. /// internal static partial class Interop { /// - /// Stt Interop Class + /// Stt interop class. /// internal static class Stt { diff --git a/Tizen.Uix.Stt/Tizen.Uix.Stt/DefaultLanguageChangedEventArgs.cs b/Tizen.Uix.Stt/Tizen.Uix.Stt/DefaultLanguageChangedEventArgs.cs index 7031f5d..ed3b72e 100755 --- a/Tizen.Uix.Stt/Tizen.Uix.Stt/DefaultLanguageChangedEventArgs.cs +++ b/Tizen.Uix.Stt/Tizen.Uix.Stt/DefaultLanguageChangedEventArgs.cs @@ -19,7 +19,7 @@ namespace Tizen.Uix.Stt { /// - /// This class holds information about the DefaultLanguageChanged Event + /// This class holds information about the DefaultLanguageChanged event. /// /// 3 public class DefaultLanguageChangedEventArgs @@ -31,7 +31,7 @@ namespace Tizen.Uix.Stt } /// - /// The previous language + /// The previous language. /// /// 3 public string PreviousLanguage @@ -41,7 +41,7 @@ namespace Tizen.Uix.Stt } /// - /// The current language + /// The current language. /// /// 3 public string CurrentLanguage diff --git a/Tizen.Uix.Stt/Tizen.Uix.Stt/EngineChangedEventArgs.cs b/Tizen.Uix.Stt/Tizen.Uix.Stt/EngineChangedEventArgs.cs index c6b5eee..49b152c 100755 --- a/Tizen.Uix.Stt/Tizen.Uix.Stt/EngineChangedEventArgs.cs +++ b/Tizen.Uix.Stt/Tizen.Uix.Stt/EngineChangedEventArgs.cs @@ -18,7 +18,7 @@ namespace Tizen.Uix.Stt { /// - /// This class holds information related to Engine Changed Event + /// This class holds information related to the EngineChanged event. /// /// 3 public class EngineChangedEventArgs @@ -32,7 +32,7 @@ namespace Tizen.Uix.Stt } /// - /// Engine Id + /// The Engine ID. /// /// 3 public string EngineId @@ -42,7 +42,7 @@ namespace Tizen.Uix.Stt } /// - /// Default Language + /// The default language. /// /// 3 public string Language @@ -52,7 +52,7 @@ namespace Tizen.Uix.Stt } /// - /// The necessity of credential + /// The necessity of the credential. /// /// 3 public bool NeedCredential @@ -62,7 +62,7 @@ namespace Tizen.Uix.Stt } /// - /// Whether the silence detection is supported or not + /// Whether silence detection is supported or not. /// /// 3 public bool SupportSilence diff --git a/Tizen.Uix.Stt/Tizen.Uix.Stt/ErrorOccurredEventArgs.cs b/Tizen.Uix.Stt/Tizen.Uix.Stt/ErrorOccurredEventArgs.cs index f479c2e..64c1e31 100755 --- a/Tizen.Uix.Stt/Tizen.Uix.Stt/ErrorOccurredEventArgs.cs +++ b/Tizen.Uix.Stt/Tizen.Uix.Stt/ErrorOccurredEventArgs.cs @@ -21,7 +21,7 @@ using static Interop.Stt; namespace Tizen.Uix.Stt { /// - /// This class holds information related to the STT ErrorOccurred Event + /// This class holds information related to the STT ErrorOccurred event. /// /// 3 public class ErrorOccurredEventArgs @@ -157,7 +157,7 @@ namespace Tizen.Uix.Stt } /// - /// The Error Value + /// The error value. /// /// 3 public Error ErrorValue @@ -171,7 +171,7 @@ namespace Tizen.Uix.Stt /// /// 3 /// - /// string error message + /// String error message. /// public string ErrorMessage { diff --git a/Tizen.Uix.Stt/Tizen.Uix.Stt/RecognitionResultEventArgs.cs b/Tizen.Uix.Stt/Tizen.Uix.Stt/RecognitionResultEventArgs.cs index 2618585..7f5fb95 100755 --- a/Tizen.Uix.Stt/Tizen.Uix.Stt/RecognitionResultEventArgs.cs +++ b/Tizen.Uix.Stt/Tizen.Uix.Stt/RecognitionResultEventArgs.cs @@ -99,7 +99,7 @@ namespace Tizen.Uix.Stt } /// - /// The result event + /// The result event. /// /// 3 public ResultEvent Result @@ -111,7 +111,7 @@ namespace Tizen.Uix.Stt } /// - /// Result texts. + /// The result text. /// /// 3 public IEnumerable Data @@ -123,7 +123,7 @@ namespace Tizen.Uix.Stt } /// - /// Returns the Result text count. + /// Returns the result text count. /// /// 3 public int DataCount @@ -135,7 +135,7 @@ namespace Tizen.Uix.Stt } /// - /// Engine message + /// The engine message. /// /// 3 public ResultMessage Message diff --git a/Tizen.Uix.Stt/Tizen.Uix.Stt/ResultTime.cs b/Tizen.Uix.Stt/Tizen.Uix.Stt/ResultTime.cs index ecf0b91..5b25965 100755 --- a/Tizen.Uix.Stt/Tizen.Uix.Stt/ResultTime.cs +++ b/Tizen.Uix.Stt/Tizen.Uix.Stt/ResultTime.cs @@ -20,7 +20,7 @@ using static Interop.Stt; namespace Tizen.Uix.Stt { /// - /// This Class represents the result of recognition result from the engine. + /// This class represents the result of recognition result from the engine. /// /// 3 public class ResultTime @@ -35,7 +35,7 @@ namespace Tizen.Uix.Stt } /// - /// The result index + /// The result index. /// /// 3 public int Index @@ -45,7 +45,7 @@ namespace Tizen.Uix.Stt } /// - /// The token event + /// The token event. /// /// 3 public TimeEvent TokenEvent @@ -55,7 +55,7 @@ namespace Tizen.Uix.Stt } /// - /// The result text + /// The result text. /// /// 3 public string Text @@ -65,7 +65,7 @@ namespace Tizen.Uix.Stt } /// - /// The start time of result text + /// The start time of result text. /// /// 3 public long StartTime @@ -75,7 +75,7 @@ namespace Tizen.Uix.Stt } /// - /// The end time of result text + /// The end time of result text. /// /// 3 public long EndTime diff --git a/Tizen.Uix.Stt/Tizen.Uix.Stt/StateChangedEventArgs.cs b/Tizen.Uix.Stt/Tizen.Uix.Stt/StateChangedEventArgs.cs index eb55c4c..6edbede 100755 --- a/Tizen.Uix.Stt/Tizen.Uix.Stt/StateChangedEventArgs.cs +++ b/Tizen.Uix.Stt/Tizen.Uix.Stt/StateChangedEventArgs.cs @@ -18,7 +18,7 @@ namespace Tizen.Uix.Stt { /// - /// This class holds information related to the STT StateChanged event + /// This class holds information related to the STT StateChanged event. /// /// 3 public class StateChangedEventArgs @@ -30,7 +30,7 @@ namespace Tizen.Uix.Stt } /// - /// A previous state + /// The previous state. /// /// 3 public State Previous @@ -39,7 +39,7 @@ namespace Tizen.Uix.Stt internal set; } /// - /// A current state + /// The current state. /// /// 3 public State Current diff --git a/Tizen.Uix.Stt/Tizen.Uix.Stt/SttClient.cs b/Tizen.Uix.Stt/Tizen.Uix.Stt/SttClient.cs index c08f390..21fbebf 100644 --- a/Tizen.Uix.Stt/Tizen.Uix.Stt/SttClient.cs +++ b/Tizen.Uix.Stt/Tizen.Uix.Stt/SttClient.cs @@ -23,61 +23,61 @@ using static Interop.Stt; namespace Tizen.Uix.Stt { /// - /// The token event + /// The token event. /// /// 3 public enum ResultEvent { /// - /// Event when the recognition full or last result is ready + /// Event when the recognition for full or last result is ready. /// /// 3 FinalResult = 0, /// - /// Event when the recognition partial result is ready + /// Event when the recognition for partial result is ready. /// /// 3 PartialResult, /// - /// Event when the recognition has failed + /// Event when the recognition has failed. /// /// 3 Error }; /// - /// Enumeration representing the result message + /// Enumeration for representing the result message. /// /// 3 public enum ResultMessage { /// - /// No Error + /// No Error. /// /// 3 None, /// - /// Recognition failed because the speech started too soon. + /// Recognition failed because the speech started too soon. /// /// 3 TooSoon, /// - /// Recognition failed because the speech is too short. + /// Recognition failed because the speech is too short. /// /// 3 TooShort, /// - /// Recognition failed because the speech is too long. + /// Recognition failed because the speech is too long. /// /// 3 TooLong, /// - /// Recognition failed because the speech is too quiet to listen. + /// Recognition failed because the speech is too quiet to listen. /// /// 3 TooQuiet, /// - /// Recognition failed because the speech is too loud to listen. + /// Recognition failed because the speech is too loud to listen. /// /// 3 TooLoud, @@ -89,144 +89,144 @@ namespace Tizen.Uix.Stt }; /// - /// Enumeration for the Token type + /// Enumeration for the token types. /// /// 3 public enum TimeEvent { /// - /// Event when the token is beginning type + /// Event when the token is beginning type. /// /// 3 Beginning = 0, /// - /// Event when the token is middle type + /// Event when the token is middle type. /// /// 3 Middle = 1, /// - /// Event when the token is end type + /// Event when the token is end type. /// /// 3 End = 2 }; /// - /// Enum for Error values that can occur + /// Enumeration for the error values that can occur. /// /// 3 public enum Error { /// - /// Successful, No error + /// Successful, No error. /// /// 3 None, /// - /// Out of Memory + /// Out of Memory. /// - /// 3 + /// 3 . OutOfMemory, /// - /// I/O error + /// I/O error. /// - /// 3 + /// 3 . IoError, /// - /// Invalid parameter + /// Invalid parameter. /// /// 3 InvalidParameter, /// - /// No answer from the STT service + /// No answer from the STT service. /// /// 3 TimedOut, /// - /// Device or resource busy + /// Device or resource busy. /// /// 3 RecorderBusy, /// - /// Network is down + /// Network is down. /// /// 3 OutOfNetwork, /// - /// Permission denied + /// Permission denied. /// /// 3 PermissionDenied, /// - /// STT NOT supported + /// STT NOT supported. /// /// 3 NotSupported, /// - /// Invalid state + /// Invalid state. /// /// 3 InvalidState, /// - /// Invalid language + /// Invalid language. /// /// 3 InvalidLanguage, /// - /// No available engine + /// No available engine. /// /// 3 EngineNotFound, /// - /// Operation failed + /// Operation failed. /// /// 3 OperationFailed, /// - /// Not supported feature of current engine + /// Not supported feature of current engine. /// /// 3 NotSupportedFeature, /// - /// Recording timed out + /// Recording timed out. /// /// 3 RecordingTimedOut, /// - /// No speech while recording + /// No speech while recording. /// /// 3 NoSpeech, /// - /// Progress to ready is not finished + /// Progress to ready is not finished. /// /// 3 InProgressToReady, /// - /// Progress to recording is not finished + /// Progress to recording is not finished. /// /// 3 InProgressToRecording, /// - /// Progress to processing is not finished + /// Progress to processing is not finished. /// /// 3 InProgressToProcessing, /// - /// Service reset + /// Service reset. /// /// 3 ServiceReset }; /// - /// Enumeration for Recognition Types + /// Enumeration for the recognition types. /// /// 3 public enum RecognitionType { /// - /// Free form dictation + /// Free form dictation. /// /// 3 Free, @@ -236,73 +236,73 @@ namespace Tizen.Uix.Stt /// 3 Partial, /// - /// Search + /// Search. /// /// 3 Search, /// - /// Web Search + /// Web search. /// /// 3 WebSearch, /// - /// Map + /// Map. /// /// 3 Map }; /// - /// Enumeration for the State types + /// Enumeration for the state types. /// /// 3 public enum State { /// - /// Created state + /// Created state. /// /// 3 Created = 0, /// - /// Ready state + /// Ready state. /// /// 3 Ready = 1, /// - /// Recording state + /// Recording state. /// /// 3 Recording = 2, /// - /// Processing state + /// Processing state. /// /// 3 Processing = 3, /// - /// Unavailable + /// Unavailable. /// /// 3 Unavailable }; /// - /// Enumeration for the Silence Detection types + /// Enumeration for the silence detection types. /// /// 3 public enum SilenceDetection { /// - /// Silence detection type - False + /// Silence detection type - False. /// /// 3 False = 0, /// - /// Silence detection type - True + /// Silence detection type - True. /// /// 3 True = 1, /// - /// Silence detection type - Auto + /// Silence detection type - Auto. /// /// 3 Auto = 2 @@ -310,11 +310,11 @@ namespace Tizen.Uix.Stt /// /// A main function of Speech-To-Text (below STT) API recognizes sound data recorded by users. - /// After choosing a language, applications will start recording and recognizing. + /// After choosing a language, the applications will start recording and recognizing. /// After recording, the applications will receive the recognized result. /// The STT has a client-server for the service of multi-applications. - /// The STT service always works in the background as a server. If the service is not working, client library will invoke it and client will communicate with it. - /// The service has engines and the recorder so client does not have the recorder itself. Only the client request commands to the STT service for using STT. + /// The STT service always works in the background as a server. If the service is not working, client library will invoke it and the client will communicate with it. + /// The service has engines and a recorder, so that the client does not have the recorder itself. Only the client request commands to the STT service for using STT. /// /// 3 public class SttClient : IDisposable @@ -346,10 +346,10 @@ namespace Tizen.Uix.Stt /// http://tizen.org/feature/speech.recognition /// http://tizen.org/feature/microphone /// - /// This Exception can be due to Operation Failed. - /// This Exception can be due to Out of Memory. - /// This Exception can be due to STT Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to operation failed. + /// This exception can be due to out of memory. + /// This exception can be due to STT not supported. + /// This exception can be due to permission denied. public SttClient() { IntPtr handle; @@ -414,7 +414,7 @@ namespace Tizen.Uix.Stt } /// - /// Event to be invoked when STT state changes. + /// Event to be invoked when the STT state changes. /// /// 3 public event EventHandler StateChanged @@ -503,7 +503,7 @@ namespace Tizen.Uix.Stt } /// - /// Event to be invoked when default language change. + /// Event to be invoked when the default language changes. /// /// 3 public event EventHandler DefaultLanguageChanged @@ -550,7 +550,7 @@ namespace Tizen.Uix.Stt } /// - /// Event to be invoked to detect engine change. + /// Event to be invoked to detect the engine change. /// /// 3 public event EventHandler EngineChanged @@ -638,7 +638,7 @@ namespace Tizen.Uix.Stt /// http://tizen.org/privilege/recorder /// /// 
-        /// The State must be Recording.
+        /// The state must be recording.
         ///
public float RecordingVolume { @@ -672,7 +672,7 @@ namespace Tizen.Uix.Stt /// http://tizen.org/privilege/recorder /// /// - /// Current STT State value. + /// Current STT state value. /// public State CurrentState { @@ -705,16 +705,16 @@ namespace Tizen.Uix.Stt /// http://tizen.org/privilege/recorder /// /// - /// This Exception can occur while setting due to the following reasons + /// This exceptioncan occur while setting due to the following reasons: /// 1. Operation Failed /// 2. Invalid State /// - /// This Exception can be due to Out of Memory. - /// This Exception can be due to STT Not Supported. - /// This Exception can be due to Permission Denied. - /// This can happen if Improper EngineId is provided while setting the value. + /// This exception can be due to out of memory. + /// This exception can be due to STT not supported. + /// This exception can be due to permission denied. + /// This can happen if improper EngineId is provided while setting the value. /// 
-        /// The State must be Created.
+        /// The state must be created.
         ///
public string Engine { @@ -749,11 +749,11 @@ namespace Tizen.Uix.Stt } /// - /// Retrieves the time stamp of the current recognition result + /// Retrieves the time stamp of the current recognition result. /// /// 3 /// - /// list of ResultTime + /// List of ResultTime. /// /// /// http://tizen.org/privilege/recorder @@ -763,11 +763,11 @@ namespace Tizen.Uix.Stt /// http://tizen.org/feature/microphone /// /// - /// This function should only be called in RecognitionResult Event + /// This function should only be called in the RecognitionResult event. /// - /// This Exception can be due to Operation Failed. - /// This Exception can be due to STT Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to operation failed. + /// This exception can be due to STT not supported. + /// This exception can be due to permission denied. public IEnumerable GetDetailedResult() { List list = new List(); @@ -788,14 +788,14 @@ namespace Tizen.Uix.Stt /// - /// Gets the private data from stt engine. + /// Gets the private data from the STT engine. /// /// 3 /// - /// The key string + /// The key string. /// /// - /// The Data Corresponding to the Key provided + /// The data corresponding to the key is provided. /// /// /// http://tizen.org/privilege/recorder @@ -804,11 +804,11 @@ namespace Tizen.Uix.Stt /// http://tizen.org/feature/speech.recognition /// http://tizen.org/feature/microphone /// - /// This Exception can be due to Invalid State. - /// This Exception can be due to STT Not Supported. - /// This Exception can be due to No Answer from STT Service. + /// This exception can be due to invalid state. + /// This exception can be due to STT not supported. + /// This exception can be due to No Answer from STT Service. /// 
-        /// The State must be Ready.
+        /// The state must be ready.
         ///
public string GetPrivateData(string key) { @@ -827,14 +827,14 @@ namespace Tizen.Uix.Stt } /// - /// Sets the private data to stt engine. + /// Sets the private data to the STT engine. /// /// 3 /// - /// The key string + /// The key string. /// /// - /// The data string + /// The data string. /// /// /// http://tizen.org/privilege/recorder @@ -843,12 +843,12 @@ namespace Tizen.Uix.Stt /// http://tizen.org/feature/speech.recognition /// http://tizen.org/feature/microphone /// - /// This Exception can be due to Invalid State. - /// This Exception can be due to STT Not Supported. - /// This Exception can be due to No Answer from STT Service. - /// This can happen if Improper value is provided while setting the value. + /// This exception can be due to invalid state. + /// This exception can be due to STT not supported. + /// This exception can be due to No Answer from STT Service. + /// This can happen if Improper value is provided while setting the value. /// 
-        /// The State must be Ready.
+        /// The state must be ready.
         ///
public void SetPrivateData(string key, string data) { @@ -864,11 +864,11 @@ namespace Tizen.Uix.Stt } /// - /// Gets the list of Supported Engine + /// Gets the list of supported engines. /// /// 3 /// - /// IEnumerable<SupportedEngine> list of supported engines + /// IEnumerable<SupportedEngine> list of supported engines. /// /// /// http://tizen.org/privilege/recorder @@ -877,10 +877,10 @@ namespace Tizen.Uix.Stt /// http://tizen.org/feature/speech.recognition /// http://tizen.org/feature/microphone /// - /// This Exception can be due to Operation Failed. - /// This Exception can be due to Out of Memory. - /// This Exception can be due to STT Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to operation failed. + /// This exception can be due to out of memory. + /// This exception can be due to STT not supported. + /// This exception can be due to permission denied. public IEnumerable GetSupportedEngines() { List engineList = new List(); @@ -906,11 +906,11 @@ namespace Tizen.Uix.Stt } /// - /// Sets the app credential + /// Sets the application credential. /// /// 3 /// - /// The credential string + /// The credential string. /// /// /// http://tizen.org/privilege/recorder @@ -920,16 +920,16 @@ namespace Tizen.Uix.Stt /// http://tizen.org/feature/microphone /// /// - /// This Exception can be due to the following reasons + /// This exceptioncan be due to the following reasons: /// 1. Operation Failed /// 2. Invalid State /// - /// This Exception can be due to Out of Memory. - /// This Exception can be due to STT Not Supported. - /// This Exception can be due to Permission Denied. - /// This can happen if Improper value is provided while setting the value. + /// This exception can be due to out of memory. + /// This exception can be due to STT not supported. + /// This exception can be due to permission denied. + /// This can happen if Improper value is provided while setting the value. /// 
-        /// The State must be Created.
+        /// The state must be created.
         ///
public void SetCredential(string credential) { @@ -955,15 +955,15 @@ namespace Tizen.Uix.Stt /// http://tizen.org/feature/speech.recognition /// http://tizen.org/feature/microphone /// - /// This Exception can be due to Invalid State. - /// This Exception can be due to STT Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to invalid state. + /// This exception can be due to STT not supported. + /// This exception can be due to permission denied. /// 
-        /// The State must be Created.
+        /// The state must be created.
         ///
/// - /// If this function is successful, the STT state will be Ready - /// If this function is unsuccessful, ErrorOccurred event will be invoked + /// If this function is successful, the STT state will be ready. + /// If this function is unsuccessful, ErrorOccurred event will be invoked. /// public void Prepare() { @@ -989,14 +989,14 @@ namespace Tizen.Uix.Stt /// http://tizen.org/feature/speech.recognition /// http://tizen.org/feature/microphone /// - /// This Exception can be due to Invalid State. - /// This Exception can be due to STT Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to invalid state. + /// This exception can be due to STT not supported. + /// This exception can be due to permission denied. /// 
-        /// The State must be Ready.
+        /// The state must be ready.
         ///
/// - /// If this function is successful, the STT state will be Created + /// If this function is successful, the STT state will be Created. /// public void Unprepare() { @@ -1012,7 +1012,7 @@ namespace Tizen.Uix.Stt } /// - /// Retrieves all supported languages of current engine. + /// Retrieves all the supported languages of the current engine. /// 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. /// @@ -1021,19 +1021,19 @@ namespace Tizen.Uix.Stt /// http://tizen.org/privilege/recorder /// /// - /// list of strings of supported languages. + /// List of strings for supported languages. /// /// /// http://tizen.org/feature/speech.recognition /// http://tizen.org/feature/microphone /// /// - /// This Exception can be due to the following reasons + /// This exception can be due to the following reasons: /// 1. Engine Not Found. /// 2. Operation Failed. /// - /// This Exception can be due to STT Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to STT not supported. + /// This exception can be due to permission denied. public IEnumerable GetSupportedLanguages() { List languageList = new List(); @@ -1068,21 +1068,21 @@ namespace Tizen.Uix.Stt /// RecognitionType value. /// /// - /// bool value indicating whether the recognition type is supported. + /// Bool value indicating whether the recognition type is supported. /// /// /// http://tizen.org/feature/speech.recognition /// http://tizen.org/feature/microphone /// /// - /// This Exception can be due to the following reasons + /// This exception can be due to the following reasons: /// 1. Invalid State - /// 2. Engine Not Found. - /// 3. Operation Failed. + /// 2. Engine Not Found + /// 3. Operation Failed /// - /// This Exception can be due to STT Not Supported. + /// This exception can be due to STT not supported. /// 
-        /// The state should be Ready.
+        /// The state should be ready.
         ///
public bool IsRecognitionTypeSupported(RecognitionType type) { @@ -1151,14 +1151,14 @@ namespace Tizen.Uix.Stt /// http://tizen.org/feature/microphone /// /// - /// This Exception can be due to the following reasons + /// This exception can be due to the following reasons: /// 1. Invalid State - /// 2. Not supported feature of current engine. - /// 3. Operation Failed. + /// 2. Not supported feature of current engine + /// 3. Operation Failed /// - /// This Exception can be due to STT Not Supported. + /// This exception can be due to STT not supported. /// 
-        /// The state should be Ready.
+        /// The state should be ready.
         ///
public void SetSilenceDetection(SilenceDetection type) { @@ -1175,29 +1175,29 @@ namespace Tizen.Uix.Stt /// /// Sets the sound to start recording. - /// Sound file type should be wav type. + /// Sound file type should be .wav type. /// /// 3 /// /// http://tizen.org/privilege/recorder /// /// - /// File Path for the sound. + /// File path for the sound. /// /// /// http://tizen.org/feature/speech.recognition /// http://tizen.org/feature/microphone /// /// - /// This Exception can be due to the following reasons - /// 1. Invalid State. - /// 2. Operation Failed. + /// This exception can be due to the following reasons: + /// 1. Invalid State + /// 2. Operation Failed /// - /// This Exception can be due to STT Not Supported. - /// This Exception can be due to Permission Denied. - /// If an Invalid Parameter is provided. + /// This exception can be due to STT not supported. + /// This exception can be due to permission denied. + /// If an Invalid Parameter is provided. /// 
-        /// The state should be Ready.
+        /// The state should be ready.
         ///
public void SetStartSound(string filePath) { @@ -1224,14 +1224,14 @@ namespace Tizen.Uix.Stt /// http://tizen.org/feature/microphone /// /// - /// This Exception can be due to the following reasons - /// 1. Invalid State. - /// 2. Operation Failed. + /// This exception can be due to the following reasons: + /// 1. Invalid State + /// 2. Operation Failed /// - /// This Exception can be due to STT Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to STT not supported. + /// This exception can be due to permission denied. /// 
-        /// The state should be Ready.
+        /// The state should be ready.
         ///
public void UnsetStartSound() { @@ -1248,7 +1248,7 @@ namespace Tizen.Uix.Stt /// /// Sets the sound to stop recording. - /// Sound file type should be wav type. + /// Sound file type should be .wav type. /// /// 3 /// @@ -1262,15 +1262,15 @@ namespace Tizen.Uix.Stt /// http://tizen.org/feature/microphone /// /// - /// This Exception can be due to the following reasons - /// 1. Invalid State. - /// 2. Operation Failed. + /// This exception can be due to the following reasons: + /// 1. Invalid State + /// 2. Operation Failed /// - /// This Exception can be due to STT Not Supported. - /// This Exception can be due to Permission Denied. - /// If an Invalid Parameter is provided. + /// This exception can be due to STT not supported. + /// This exception can be due to permission denied. + /// This exception can be due to Invalid Parameter. /// 
-        /// The state should be Ready.
+        /// The state should be ready.
         ///
public void SetStopSound(string filePath) { @@ -1297,14 +1297,14 @@ namespace Tizen.Uix.Stt /// http://tizen.org/feature/microphone /// /// - /// This Exception can be due to the following reasons - /// 1. Invalid State. - /// 2. Operation Failed. + /// This exception can be due to the following reasons: + /// 1. Invalid State + /// 2. Operation Failed /// - /// This Exception can be due to STT Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to STT not supported. + /// his exception can be due to permission denied. /// 
-        /// The state should be Ready.
+        /// The state should be ready.
         ///
public void UnsetStopSound() { @@ -1320,41 +1320,41 @@ namespace Tizen.Uix.Stt } /// - /// Starts recording and recognition asynchronously. - /// This function starts recording in the STT service and sending recording data to engine. - /// This work continues until Stop, Cancel or silence detected by engine + /// Starts the recording and recognition asynchronously. + /// This function starts recording in the STT service and sends the recording data to the engine. + /// This work continues until stop, cancel, or silence is detected by engine. /// /// 3 /// /// http://tizen.org/privilege/recorder /// /// - /// The language selected + /// The language selected. /// /// - /// The type for recognition + /// The type for recognition. /// /// /// http://tizen.org/feature/speech.recognition /// http://tizen.org/feature/microphone /// /// - /// This Exception can be due to the following reasons - /// 1. Invalid State. - /// 2. Operation Failed. - /// 3. Recorder Busy. + /// This exception can be due to the following reasons: + /// 1. Invalid State + /// 2. Operation Failed + /// 3. Recorder Busy /// 4. Progress to recording is not finished /// - /// This Exception can be due to STT Not Supported. - /// This Exception can be due to Permission Denied. - /// If an Invalid Language is provided. + /// This exception can be due to STT not supported. + /// This exception can be due to permission denied. + /// This exception can be due to an invalid language. /// 
-        /// The state should be Ready.
+        /// The state should be ready.
         ///
/// - /// It will invoke StateChanged Event if registered. - /// If this function succeeds, the STT state will be Recording. - /// If you call this function again before state changes, you will receive ErrorINProgressToRecording. + /// It will invoke the StateChanged event, if registered. + /// If this function succeeds, the STT state will be recording. + /// If you call this function again before the state changes, you will receive ErrorINProgressToRecording. /// public void Start(string language, RecognitionType type) { @@ -1405,7 +1405,7 @@ namespace Tizen.Uix.Stt } /// - /// Finishes the recording and starts recognition processing in engine asynchronously. + /// Finishes the recording and starts recognition processing in the engine asynchronously. /// /// 3 /// @@ -1416,23 +1416,23 @@ namespace Tizen.Uix.Stt /// http://tizen.org/feature/microphone /// /// - /// This Exception can be due to the following reasons - /// 1. Invalid State. - /// 2. Operation Failed. - /// 3. Progress to ready is not finished. - /// 4. Progress to recording is not finished. - /// 5. Progress to processing is not finished. + /// This exception can be due to the following reasons: + /// 1. Invalid State + /// 2. Operation Failed + /// 3. Progress to ready is not finished + /// 4. Progress to recording is not finished + /// 5. Progress to processing is not finished /// - /// This Exception can be due to STT Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to STT not supported. + /// This exception can be due to permission denied. /// 
         /// The state should be Recording.
         ///
/// - /// It will invoke StateChanged Event if registered. - /// If this function succeeds, the STT state will be Processing. - /// If you call this function again before state changes, you will receive ErrorINProgressToProcessing. - /// After processing of engine, RecognitionResult event is invoked + /// It will invoke the StateChanged Event, if registered. + /// If this function succeeds, the STT state will be processing. + /// If you call this function again before the state changes, you will receive ErrorINProgressToProcessing. + /// After processing of engine, the RecognitionResult event is invoked. /// public void Stop() { @@ -1448,9 +1448,9 @@ namespace Tizen.Uix.Stt } /// - /// Cancels processing recognition and recording asynchronously. - /// This function cancels recording and engine cancels recognition processing. - /// After successful cancel, StateChanged event is invoked otherwise if error is occurred, ErrorOccurred event is invoked. + /// Cancels processing the recognition and recording asynchronously. + /// This function cancels recording and the engine cancels recognition processing. + /// After successful cancellation, the StateChanged event is invoked, otherwise if an error is occurs, the ErrorOccurred event is invoked. /// /// 3 /// @@ -1461,22 +1461,22 @@ namespace Tizen.Uix.Stt /// http://tizen.org/feature/microphone /// /// - /// This Exception can be due to the following reasons - /// 1. Invalid State. - /// 2. Operation Failed. - /// 3. Progress to ready is not finished. - /// 4. Progress to recording is not finished. - /// 5. Progress to processing is not finished. + /// This exception can be due to the following reasons: + /// 1. Invalid State + /// 2. Operation Failed + /// 3. Progress to ready is not finished + /// 4. Progress to recording is not finished + /// 5. Progress to processing is not finished /// - /// This Exception can be due to STT Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to STT not supported. + /// This exception can be due to permission denied. /// 
         /// The state should be Recording or Processing.
         ///
/// - /// It will invoke StateChanged Event if registered. - /// If this function succeeds, the STT state will be Ready. - /// If you call this function again before state changes, you will receive ErrorINProgressToReady. + /// It will invoke the StateChanged event, if registered. + /// If this function succeeds, the STT state will be ready. + /// If you call this function again before the state changes, you will receive ErrorINProgressToReady. /// public void Cancel() { @@ -1492,7 +1492,7 @@ namespace Tizen.Uix.Stt } /// - /// Method to release resources + /// A method to release resources. /// public void Dispose() { diff --git a/Tizen.Uix.Stt/Tizen.Uix.Stt/SupportedEngine.cs b/Tizen.Uix.Stt/Tizen.Uix.Stt/SupportedEngine.cs index d2129e8..ace1010 100755 --- a/Tizen.Uix.Stt/Tizen.Uix.Stt/SupportedEngine.cs +++ b/Tizen.Uix.Stt/Tizen.Uix.Stt/SupportedEngine.cs @@ -18,7 +18,7 @@ namespace Tizen.Uix.Stt { /// - /// This Class provideds the Information related to STT Engine. + /// This class provides the information related to STT engine. /// /// 3 public class SupportedEngine @@ -32,11 +32,11 @@ namespace Tizen.Uix.Stt this._engineName = name; } /// - /// The Engine Id + /// The engine ID. /// /// 3 /// - /// The string Engine Id + /// The string engine ID. /// public string EngineId { @@ -47,11 +47,11 @@ namespace Tizen.Uix.Stt } /// - /// The Engine Name + /// The engine name. /// /// 3 /// - /// The string Engine Name + /// The string engine name. /// public string EngineName { -- 2.7.4