From 4f52f0f669a66572b57b04c258367317637c6849 Mon Sep 17 00:00:00 2001 From: Editor Lionbridge Date: Wed, 26 Jul 2017 11:32:02 +0530 Subject: [PATCH] Review UIX-TTS API cs files PS1: Edited few summary tag descriptions PS2: Updated the description for inline comment Change-Id: Ib2692eaea1d375c01da55527d2f730a1114f2ed9 --- src/Tizen.Uix.Tts/Interop/Interop.Libraries.cs | 4 +- src/Tizen.Uix.Tts/Interop/Interop.Tts.cs | 4 +- .../Tizen.Uix.Tts/DefaultVoiceChangedEventArgs.cs | 6 +- .../Tizen.Uix.Tts/EngineChangedEventArgs.cs | 8 +- .../Tizen.Uix.Tts/ErrorOccurredEventArgs.cs | 8 +- src/Tizen.Uix.Tts/Tizen.Uix.Tts/SpeedRange.cs | 8 +- .../Tizen.Uix.Tts/StateChangedEventArgs.cs | 6 +- src/Tizen.Uix.Tts/Tizen.Uix.Tts/SupportedVoice.cs | 4 +- src/Tizen.Uix.Tts/Tizen.Uix.Tts/TtsClient.cs | 208 ++++++++++----------- .../Tizen.Uix.Tts/UtteranceEventArgs.cs | 4 +- 10 files changed, 130 insertions(+), 130 deletions(-) diff --git a/src/Tizen.Uix.Tts/Interop/Interop.Libraries.cs b/src/Tizen.Uix.Tts/Interop/Interop.Libraries.cs index b99ba12..2161d63 100755 --- a/src/Tizen.Uix.Tts/Interop/Interop.Libraries.cs +++ b/src/Tizen.Uix.Tts/Interop/Interop.Libraries.cs @@ -15,12 +15,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/src/Tizen.Uix.Tts/Interop/Interop.Tts.cs b/src/Tizen.Uix.Tts/Interop/Interop.Tts.cs index be7999d..32b49ba 100755 --- a/src/Tizen.Uix.Tts/Interop/Interop.Tts.cs +++ b/src/Tizen.Uix.Tts/Interop/Interop.Tts.cs @@ -20,12 +20,12 @@ using System.Runtime.InteropServices; using Tizen.Uix.Tts; /// -/// Partial Interop Class +/// Partial interop class. /// internal static partial class Interop { /// - /// Tts Interop Class + /// Tts interop class. /// internal static class Tts { diff --git a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/DefaultVoiceChangedEventArgs.cs b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/DefaultVoiceChangedEventArgs.cs index 6ece3cc..1cfd40c 100755 --- a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/DefaultVoiceChangedEventArgs.cs +++ b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/DefaultVoiceChangedEventArgs.cs @@ -18,7 +18,7 @@ namespace Tizen.Uix.Tts { /// - /// This Class holds information related to DefaultVoiceChanged Event + /// This class holds information related to the DefaultVoiceChanged event. /// /// 3 public class DefaultVoiceChangedEventArgs @@ -30,7 +30,7 @@ namespace Tizen.Uix.Tts } /// - /// The Previous SupportedVoice + /// The previous SupportedVoice. /// /// 3 public SupportedVoice Previous @@ -40,7 +40,7 @@ namespace Tizen.Uix.Tts } /// - /// The current SupportedVoice + /// The current SupportedVoice. /// /// 3 public SupportedVoice Current diff --git a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/EngineChangedEventArgs.cs b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/EngineChangedEventArgs.cs index 6419660..5a3c00a 100755 --- a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/EngineChangedEventArgs.cs +++ b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/EngineChangedEventArgs.cs @@ -20,7 +20,7 @@ using static Tizen.Uix.Tts.SupportedVoice; namespace Tizen.Uix.Tts { /// - /// This class holds information related to Engine Changed Event + /// This class holds information related to the EngineChanged event. /// /// 3 public class EngineChangedEventArgs @@ -33,7 +33,7 @@ namespace Tizen.Uix.Tts } /// - /// Engine Id + /// The engine ID. /// /// 3 public string EngineId @@ -43,7 +43,7 @@ namespace Tizen.Uix.Tts } /// - /// The necessity of credential + /// The necessity of the credential. /// /// 3 public bool NeedCredential @@ -53,7 +53,7 @@ namespace Tizen.Uix.Tts } /// - /// The supported voice + /// The supported voice. /// /// 3 public SupportedVoice VoiceType diff --git a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/ErrorOccurredEventArgs.cs b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/ErrorOccurredEventArgs.cs index 09bcb67..0a184db 100755 --- a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/ErrorOccurredEventArgs.cs +++ b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/ErrorOccurredEventArgs.cs @@ -21,7 +21,7 @@ using static Interop.Tts; namespace Tizen.Uix.Tts { /// - /// This class holds information related to the TTS ErrorOccurred Event + /// This class holds information related to the TTS ErrorOccurred event. /// /// 3 public class ErrorOccurredEventArgs @@ -115,7 +115,7 @@ namespace Tizen.Uix.Tts } /// - /// The Utterance Id + /// The utterance ID. /// /// 3 public int UtteranceId @@ -125,7 +125,7 @@ namespace Tizen.Uix.Tts } /// - /// The Error Value + /// The error value. /// /// 3 public Error ErrorValue @@ -139,7 +139,7 @@ namespace Tizen.Uix.Tts /// /// 3 /// - /// string error message + /// String error message. /// public string ErrorMessage { diff --git a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/SpeedRange.cs b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/SpeedRange.cs index dbe1f68..2ed55c3 100755 --- a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/SpeedRange.cs +++ b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/SpeedRange.cs @@ -18,7 +18,7 @@ namespace Tizen.Uix.Tts { /// - /// This class holds the Speed Range Values + /// This class holds the speed range values. /// /// 3 public class SpeedRange @@ -31,7 +31,7 @@ namespace Tizen.Uix.Tts } /// - /// The Max Speed Range Value + /// The max speed range value. /// /// 3 public int Max @@ -41,7 +41,7 @@ namespace Tizen.Uix.Tts } /// - /// The Min Speed Range Value + /// The min speed range value. /// /// 3 public int Min @@ -51,7 +51,7 @@ namespace Tizen.Uix.Tts } /// - /// The Normal Speed Range Value + /// The normal speed range value. /// /// 3 public int Normal diff --git a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/StateChangedEventArgs.cs b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/StateChangedEventArgs.cs index ba1db04..8339eb5 100755 --- a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/StateChangedEventArgs.cs +++ b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/StateChangedEventArgs.cs @@ -18,7 +18,7 @@ namespace Tizen.Uix.Tts { /// - /// This class holds information related to the TTS state change event + /// This class holds information related to the TTS StateChanged event. /// /// 3 public class StateChangedEventArgs @@ -30,7 +30,7 @@ namespace Tizen.Uix.Tts } /// - /// A previous state + /// The previous state. /// /// 3 public State Previous @@ -40,7 +40,7 @@ namespace Tizen.Uix.Tts } /// - /// A current state + /// The current state. /// /// 3 public State Current diff --git a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/SupportedVoice.cs b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/SupportedVoice.cs index eb6f75b..e99108b 100755 --- a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/SupportedVoice.cs +++ b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/SupportedVoice.cs @@ -18,7 +18,7 @@ namespace Tizen.Uix.Tts { /// - /// This Class holds information about the Supported Voices. + /// This class holds information about the supported voices. /// /// 3 public class SupportedVoice @@ -54,7 +54,7 @@ namespace Tizen.Uix.Tts } /// - /// Language 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) + /// Language 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). /// /// 3 public string Language diff --git a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/TtsClient.cs b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/TtsClient.cs index 87cfb12..f8af3a1 100755 --- a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/TtsClient.cs +++ b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/TtsClient.cs @@ -23,37 +23,37 @@ using static Interop.Tts; namespace Tizen.Uix.Tts { /// - /// Enumeration for States + /// Enumeration for the states. /// /// 3 public enum State { /// - /// Created atate + /// Created state. /// /// 3 Created = 0, /// - /// Ready state + /// Ready state. /// /// 3 Ready = 1, /// - /// Playing state + /// Playing state. /// /// 3 Playing = 2, /// - /// Paused state + /// Paused state. /// /// 3 Paused = 3, /// - /// state Unavailable + /// Unavailable state. /// /// 3 Unavailable @@ -66,123 +66,123 @@ namespace Tizen.Uix.Tts public enum Mode { /// - /// Default mode for normal application + /// Default mode for normal application. /// /// 3 Default = 0, /// - /// Notification mode + /// Notification mode. /// /// 3 Notification = 1, /// - /// Accessibiliity mode + /// Accessibility mode. /// /// 3 ScreenReader = 2 }; /// - /// Enum for Error values that can occur + /// Enumeration for error values that can occur. /// /// 3 public enum Error { /// - /// Successful, No error + /// Successful, no error. /// /// 3 None, /// - /// Out of Memory + /// Out of memory. /// /// 3 OutOfMemory, /// - /// I/O error + /// I/O error. /// /// 3 IoError, /// - /// Invalid parameter + /// Invalid parameter. /// /// 3 InvalidParameter, /// - /// No answer from the STT service + /// No answer from the STT service. /// /// 3 TimedOut, /// - /// 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 Voice + /// Invalid voice. /// /// 3 InvalidVoice, /// - /// No available engine + /// No available engine. /// /// 3 EngineNotFound, /// - /// Operation failed + /// Operation failed. /// /// 3 OperationFailed, /// - /// Audio policy blocked + /// Audio policy blocked. /// /// 3 AudioPolicyBlocked }; /// - /// Enumeration for Voice Types + /// Enumeration for the voice types. /// /// 3 public enum Voice { /// - /// Automatic Voice Type + /// The automatic voice type. /// /// 3 Auto, /// - /// Male Voice + /// The male voice type. /// /// 3 Male, /// - /// Female Voice + /// The female voice type. /// /// 3 Female, /// - /// Child Voice Type + /// The child voice type. /// /// 3 Child @@ -220,12 +220,12 @@ namespace Tizen.Uix.Tts /// http://tizen.org/feature/speech.synthesis /// /// - /// This Exception can be due to the following reasons + /// This exception can be due to the following reasons: /// 1. Operation Failed /// 2. Engine Not Found /// - /// This Exception can be due to Out Of Memory. - /// This Exception can be due to TTS Not Supported. + /// This exception can be due to out Of memory. + /// This exception can be due to TTS not supported. public TtsClient() { IntPtr handle; @@ -505,10 +505,10 @@ namespace Tizen.Uix.Tts /// /// 3 /// - /// Default voice in TTS + /// The default voice in TTS. /// /// - /// Default Voice SupportedVoice value. + /// The default voice SupportedVoice value. /// public SupportedVoice DefaultVoice { @@ -535,13 +535,13 @@ namespace Tizen.Uix.Tts /// /// 3 /// - /// Maximum byte size for text + /// The Maximum byte size for text. /// /// - /// Default Voice SupportedVoice value, 0 if unable to get the value + /// The Default Voice SupportedVoice value, 0 if unable to get the value. /// /// 
-        /// The State should be Ready
+        /// The State should be ready.
         ///
public uint MaxTextSize { @@ -569,7 +569,7 @@ namespace Tizen.Uix.Tts /// /// 3 /// - /// Current state of TTS + /// The current state of TTS. /// /// /// Current TTS State value. @@ -596,24 +596,24 @@ namespace Tizen.Uix.Tts } /// - /// The TTS Mode can be set using this property + /// The TTS Mode can be set using this property. /// /// 3 /// - /// Current mode of TTS (default, screen-reader, notification) + /// The current TTS mode (default, screen-reader, notification). /// /// - /// The Mode value + /// The Mode value. /// /// - /// This Exception can be due to the following reasons while setting the value + /// This exception can be due to the following reasons while setting the value: /// 1. Operation Failed /// 2. Engine Not Found /// - /// This Exception can be due to Out Of Memory. - /// This Exception can be due to TTS Not Supported. + /// This exception can be due to out Of memory. + /// This exception can be due to TTS not supported. /// 
-        /// State should be Created
+        /// The State should be created.
         ///
public Mode CurrentMode { @@ -649,20 +649,20 @@ namespace Tizen.Uix.Tts } /// - /// Sets the app credential + /// Sets the application credential. /// /// 3 - /// - /// The credential string + /// . + /// The credential string. /// /// /// http://tizen.org/feature/speech.synthesis /// - /// This Exception can be due to Invalid State. - /// This Exception can be due to TTS Not Supported. - /// This can happen if Improper value is provided while setting the value. + /// This exception can be due to an invalid state. + /// This exception can be due to TTS not supported. + /// This exception can be due to improper value provided while setting the value. /// 
-        /// The State must be Created or Ready.
+        /// The State should be created or ready.
         ///
public void SetCredential(string credential) { @@ -684,14 +684,14 @@ namespace Tizen.Uix.Tts /// /// http://tizen.org/feature/speech.synthesis /// - /// This Exception can be due to Invalid State. - /// This Exception can be due to TTS Not Supported. + /// This exception can be due to an invalid state. + /// This exception can be due to TTS not supported. /// 
         /// The State must be Created.
         ///
/// - /// If this function is successful, the TTS state will be Ready - /// If this function is unsuccessful, ErrorOccurred event will be invoked + /// If this function is successful, the TTS state will be ready. + /// If this function is unsuccessful, ErrorOccurred event will be invoked. /// public void Prepare() { @@ -713,13 +713,13 @@ namespace Tizen.Uix.Tts /// /// http://tizen.org/feature/speech.synthesis /// - /// This Exception can be due to Invalid State. - /// This Exception can be due to TTS Not Supported. + /// This exception can be due to an invalid state. + /// This exception can be due to TTS not supported. /// 
-        /// The State must be Ready.
+        /// The state must be ready.
         ///
/// - /// If this function is successful, the TTS state will be Created + /// If this function is successful, the TTS state will be created. /// public void Unprepare() { @@ -739,17 +739,17 @@ namespace Tizen.Uix.Tts /// /// 3 /// - /// list of SupportedVoice. + /// The list of SupportedVoice. /// /// /// http://tizen.org/feature/speech.synthesis /// /// - /// This Exception can be due to the following reasons - /// 1. Engine Not Found. - /// 2. Operation Failed. + /// This exception can be due to the following reasons: + /// 1. Engine Not Found + /// 2. Operation Failed /// - /// This Exception can be due to TTS Not Supported. + /// This exception can be due to TTS not supported. public IEnumerable GetSupportedVoices() { List voicesList = new List(); @@ -775,27 +775,27 @@ namespace Tizen.Uix.Tts } /// - /// Gets the private data from tts engine. + /// Gets the private data from TTS engine. /// /// 3 /// - /// The key string + /// The key string. /// /// - /// The Data Corresponding to the Key provided + /// The data corresponding to the provided key. /// /// /// http://tizen.org/feature/speech.synthesis /// /// - /// 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 Failure /// - /// This Exception can be due to TTS Not Supported. + /// This exception can be due to TTS not supported. /// 
-        /// The State must be Ready.
+        /// The state must be ready.
         ///
public string GetPrivateData(string key) { @@ -819,24 +819,24 @@ namespace Tizen.Uix.Tts /// /// 3 /// - /// The key string + /// The key string. /// /// - /// The data string + /// The data string. /// /// /// http://tizen.org/feature/speech.synthesis /// /// - /// 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 Failure /// - /// This Exception can be due to TTS Not Supported. - /// This can happen if Improper value is provided while setting the value. + /// This exception can be due to TTS not supported. + /// This exception can be due to improper value provided while setting the value. /// 
-        /// The State must be Ready.
+        /// The state must be ready.
         ///
public void SetPrivateData(string key, string data) { @@ -856,19 +856,19 @@ namespace Tizen.Uix.Tts /// /// 3 /// - /// The SpeedRange value + /// The SpeedRange value. /// /// /// http://tizen.org/feature/speech.synthesis /// /// - /// This Exception can be due to the following reasons + /// This exception can be due to the following reasons: /// 1. Invalid State /// 2. Operation Failure /// - /// This Exception can be due to TTS Not Supported. + /// This exception can be due to TTS not supported. /// 
-        /// The State must be Created.
+        /// The state must be created.
         ///
public SpeedRange GetSpeedRange() { @@ -892,19 +892,19 @@ namespace Tizen.Uix.Tts /// /// 3 /// - /// Locale MUST be set for utf8 text validation check. + /// Locale MUST be set for UTF-8 text validation check. /// /// - /// An input text based utf8 + /// An input text based UTF-8. /// /// - /// The language selected from the SupportedVoice.Language Property obtained from GetSupportedVoices() (e.g. 'NULL'(Automatic), 'en_US') + /// The language selected from the SupportedVoice.Language Property obtained from GetSupportedVoices()(e.g. 'NULL'(Automatic),'en_US'). /// /// - /// The voice type selected from the SupportedVoice.VoiceType Property obtained from GetSupportedVoices() + /// The voice type selected from the SupportedVoice.VoiceType Property obtained from GetSupportedVoices(). /// /// - /// A speaking speed (e.g.0 for Auto or the value from SpeedRange Property) + /// A speaking speed (e.g.0 for Auto or the value from SpeedRange Property). /// /// /// The utterance ID. @@ -913,16 +913,16 @@ namespace Tizen.Uix.Tts /// http://tizen.org/feature/speech.synthesis /// /// - /// This Exception can be due to the following reasons + /// This exception can be due to the following reasons: /// 1. Invalid State /// 2. Operation Failure /// 3. Invalid Voice /// - /// This Exception can be due to TTS Not Supported. - /// This Exception can be due to Permission Denied. - /// This can happen if Improper value is provided. + /// This exception can be due to TTS not supported. + /// This exception can be due to permission denied. + /// This exception can be due to improper value provided while setting the value. /// 
-        /// The State must be Ready or Playing or Paused.
+        /// The state must be ready or playing or paused.
         ///
public int AddText(string text, string language, int voiceType, int speed) { @@ -949,18 +949,18 @@ namespace Tizen.Uix.Tts /// http://tizen.org/feature/speech.synthesis /// /// - /// This Exception can be due to the following reasons + /// This exception can be due to the following reasons: /// 1. Invalid State /// 2. Operation Failure /// 3. Out of Network /// - /// This Exception can be due to TTS Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to TTS not supported. + /// This exception can be due to permission denied. /// 
-        /// The State must be Ready or Paused.
+        /// The state must be ready or paused.
         ///
/// - /// If this function succeeds, the TTS state will be Playing. + /// If this function succeeds, the TTS state will be playing. /// public void Play() { @@ -983,16 +983,16 @@ namespace Tizen.Uix.Tts /// http://tizen.org/feature/speech.synthesis /// /// - /// This Exception can be due to the following reasons - /// 1. Invalid State + /// This exception can be due to the following reasons: + /// 1. Invalid Stat /// 2. Operation Failure /// - /// This Exception can be due to TTS Not Supported. + /// This exception can be due to TTS not supported. /// 
-        /// The State must be Ready or Playing or Paused.
+        /// The state must be ready or playing or paused.
         ///
/// - /// If this function succeeds, the TTS state will be Ready. + /// If this function succeeds, the TTS state will be ready. /// This function will remove all text added via AddText() and synthesized sound data. /// public void Stop() @@ -1016,13 +1016,13 @@ namespace Tizen.Uix.Tts /// http://tizen.org/feature/speech.synthesis /// /// - /// This Exception can be due to the following reasons + /// This exception can be due to the following reasons: /// 1. Invalid State /// 2. Operation Failure /// - /// This Exception can be due to TTS Not Supported. + /// This exception can be due to TTS not supported. /// 
-        /// The State must be Playing.
+        /// The state must be playing.
         ///
/// /// If this function succeeds, the TTS state will be Paused. @@ -1041,7 +1041,7 @@ namespace Tizen.Uix.Tts } /// - /// Method to release resources + /// Method to release resources. /// /// 3 public void Dispose() diff --git a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/UtteranceEventArgs.cs b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/UtteranceEventArgs.cs index ba06b1d..a37c336 100755 --- a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/UtteranceEventArgs.cs +++ b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/UtteranceEventArgs.cs @@ -18,7 +18,7 @@ namespace Tizen.Uix.Tts { /// - /// This Class hold information related to UtteranceStared and UtteranceCompleted Events + /// This class holds information related to UtteranceStared and UtteranceCompleted events. /// /// 3 public class UtteranceEventArgs @@ -29,7 +29,7 @@ namespace Tizen.Uix.Tts } /// - /// The utterance ID + /// The utterance ID. /// /// 3 public int UtteranceId -- 2.7.4