From 9d2e1ee19cbc07e7a243db283e7bec5ccc6ef0a6 Mon Sep 17 00:00:00 2001 From: Editor Lionbridge Date: Wed, 26 Jul 2017 11:32:18 +0530 Subject: [PATCH] Review UIX-VOICE-CONTROL API cs files PS1: Edited casing for a sentence PS2: Edited as per comments PS3: Recover deleted files PS7: Edited VoiceControlClient API cs file Change-Id: I293cf5a1209288324f04e95c1a27ad4440af6e08 --- .../Interop/Interop.Libraries.cs | 4 +- .../Interop/Interop.VoiceControl.cs | 4 +- .../Interop/Interop.VoiceControlCommand.cs | 4 +- .../Tizen.Uix.VoiceControl.snk | Bin .../CurrentLanguageChangedEventArgs.cs | 6 +- .../ErrorOccuredEventArgs.cs | 4 +- .../ExceptionFactory.cs | 0 .../RecognitionResult.cs | 10 +- .../RecognitionResultEventArgs.cs | 2 +- .../ServiceStateChangedEventArgs.cs | 6 +- .../StateChangedEventArgs.cs | 6 +- .../Tizen.Uix.VoiceControl/VoiceCommand.cs | 52 ++-- .../VoiceCommandList.cs | 80 ++--- .../VoiceControlClient.cs | 274 +++++++++--------- 14 files changed, 226 insertions(+), 226 deletions(-) mode change 100755 => 100644 Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl.snk mode change 100755 => 100644 Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/ExceptionFactory.cs diff --git a/Tizen.Uix.VoiceControl/Interop/Interop.Libraries.cs b/Tizen.Uix.VoiceControl/Interop/Interop.Libraries.cs index 22f391b..c336e9a 100755 --- a/Tizen.Uix.VoiceControl/Interop/Interop.Libraries.cs +++ b/Tizen.Uix.VoiceControl/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/Tizen.Uix.VoiceControl/Interop/Interop.VoiceControl.cs b/Tizen.Uix.VoiceControl/Interop/Interop.VoiceControl.cs index edc20f6..f6d386e 100755 --- a/Tizen.Uix.VoiceControl/Interop/Interop.VoiceControl.cs +++ b/Tizen.Uix.VoiceControl/Interop/Interop.VoiceControl.cs @@ -21,12 +21,12 @@ using Tizen.Uix.VoiceControl; using static Interop.VoiceControlCommand; /// -/// Partial Interop Class +/// Partial interop class. /// internal static partial class Interop { /// - /// VoiceControl Interop Class + /// VoiceControl interop class. /// internal static class VoiceControl { diff --git a/Tizen.Uix.VoiceControl/Interop/Interop.VoiceControlCommand.cs b/Tizen.Uix.VoiceControl/Interop/Interop.VoiceControlCommand.cs index c29057a..e9d9bc0 100755 --- a/Tizen.Uix.VoiceControl/Interop/Interop.VoiceControlCommand.cs +++ b/Tizen.Uix.VoiceControl/Interop/Interop.VoiceControlCommand.cs @@ -21,12 +21,12 @@ using Tizen; using Tizen.Uix.VoiceControl; /// -/// Partial Interop Class +/// Partial interop class. /// internal static partial class Interop { /// - /// VoiceControlCommand Interop Class + /// VoiceControlCommand interop class. /// internal static class VoiceControlCommand { diff --git a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl.snk b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl.snk old mode 100755 new mode 100644 diff --git a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/CurrentLanguageChangedEventArgs.cs b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/CurrentLanguageChangedEventArgs.cs index 8ab933d..f5afbbe 100755 --- a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/CurrentLanguageChangedEventArgs.cs +++ b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/CurrentLanguageChangedEventArgs.cs @@ -17,7 +17,7 @@ namespace Tizen.Uix.VoiceControl { /// - /// This class holds information about the CurrentLanguageChanged Event + /// This class holds information about the CurrentLanguageChanged event. /// /// 3 public class CurrentLanguageChangedEventArgs @@ -29,7 +29,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// The previous language + /// The previous language. /// /// 3 public string PreviousLanguage @@ -39,7 +39,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// The current language + /// The current language. /// /// 3 public string CurrentLanguage diff --git a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/ErrorOccuredEventArgs.cs b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/ErrorOccuredEventArgs.cs index ce5de7b..da5c5f4 100755 --- a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/ErrorOccuredEventArgs.cs +++ b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/ErrorOccuredEventArgs.cs @@ -20,7 +20,7 @@ using static Interop.VoiceControl; namespace Tizen.Uix.VoiceControl { /// - /// This class holds information related to the VoiceControl ErrorOccured Event + /// This class holds information related to the VoiceControl ErrorOccured event. /// /// 3 public class ErrorOccuredEventArgs @@ -146,7 +146,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// The Error Value + /// The error value. /// /// 3 public Error ErrorValue diff --git a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/ExceptionFactory.cs b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/ExceptionFactory.cs old mode 100755 new mode 100644 diff --git a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/RecognitionResult.cs b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/RecognitionResult.cs index d3e3103..523a672 100755 --- a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/RecognitionResult.cs +++ b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/RecognitionResult.cs @@ -24,8 +24,8 @@ namespace Tizen.Uix.VoiceControl { /// /// The recognition result from the engine. - /// If the duplicated commands are recognized, the event(e.g. Result.Rejected) of command may be rejected - /// for selecting command as priority.If you set similar or same commands or the recognized results are multi-results, CommandList has the multi commands. + /// If the duplicated commands are recognized, the event(e.g. Result.Rejected) of a command may be rejected + /// for selecting the command as a priority. If you set similar or same commands, or the recognized results are multi-results, the CommandList has multi commands. /// /// 3 public class RecognitionResult @@ -44,7 +44,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// The result event + /// The result event. /// /// 3 public ResultEvent Result @@ -56,7 +56,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// The spoken text + /// The spoken text. /// /// 3 public string ResultMessage @@ -69,7 +69,7 @@ namespace Tizen.Uix.VoiceControl /// - /// The recognized command list + /// The recognized command list. /// /// 3 public VoiceCommandList CommandList diff --git a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/RecognitionResultEventArgs.cs b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/RecognitionResultEventArgs.cs index c3fc3dc..536f216 100755 --- a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/RecognitionResultEventArgs.cs +++ b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/RecognitionResultEventArgs.cs @@ -31,7 +31,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// Gets the Recognition result + /// Gets the recognition result. /// /// 3 public RecognitionResult Result diff --git a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/ServiceStateChangedEventArgs.cs b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/ServiceStateChangedEventArgs.cs index 077c623..a20281c 100755 --- a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/ServiceStateChangedEventArgs.cs +++ b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/ServiceStateChangedEventArgs.cs @@ -17,7 +17,7 @@ namespace Tizen.Uix.VoiceControl { /// - /// This class holds information related to the VoiceControl service ServiceStateChanged event + /// This class holds information related to the VoiceControl service ServiceStateChanged event. /// /// 3 public class ServiceStateChangedEventArgs @@ -29,7 +29,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// A previous state + /// The previous state. /// /// 3 public ServiceState Previous @@ -39,7 +39,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// A current state + /// The current state. /// /// 3 public ServiceState Current diff --git a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/StateChangedEventArgs.cs b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/StateChangedEventArgs.cs index d69e2fe..011554d 100755 --- a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/StateChangedEventArgs.cs +++ b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/StateChangedEventArgs.cs @@ -17,7 +17,7 @@ namespace Tizen.Uix.VoiceControl { /// - /// This class holds information related to the VoiceControl client StateChanged event + /// This class holds information related to the VoiceControl client StateChanged event. /// /// 3 public class StateChangedEventArgs @@ -29,7 +29,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// A previous state + /// The previous state. /// /// 3 public State Previous @@ -39,7 +39,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// A current state + /// The current state. /// /// 3 public State Current diff --git a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceCommand.cs b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceCommand.cs index b6be557..1175c4a 100755 --- a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceCommand.cs +++ b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceCommand.cs @@ -21,39 +21,39 @@ using static Interop.VoiceControlCommand; namespace Tizen.Uix.VoiceControl { /// - /// Enumeration for Command Format + /// Enumeration for the command format. /// /// 3 public enum CommandFormat { /// - /// fixed command format. + /// The fixed command format. /// Fixed = 0, /// - /// fixed and variable fixed command format. + /// The fixed and variable fixed command format. /// FixedAndVFixed = 1, /// - /// variable fixed and fixed command format. + /// The variable fixed and fixed command format. /// VFixedAndFixed = 2, /// - /// fixed and non-fixed command format. + /// The fixed and non-fixed command format. /// FixedAndNonFixed = 3, /// - /// non-fixed and fixed command format. + /// The non-fixed and fixed command format. /// NonFixedAndFixed = 4, /// - /// Undefined + /// Undefined. /// Undefined = 5 }; /// - /// This class represents a Voice Command + /// This class represents a voice command. /// /// 3 public class VoiceCommand @@ -61,13 +61,13 @@ namespace Tizen.Uix.VoiceControl internal SafeCommandHandle _handle; /// - /// Public Constructor + /// The public constructor. /// /// 3 - /// This Exception can be due to Invalid State. - /// This Exception can be due to Out Of Memory. - /// This Exception can be due to Permission Denied. - /// This Exception can be due to Not Supported. + /// This exception can be due to an invalid state. + /// This exception can be due to out Of memory. + /// This exception can be due to permission denied. + /// This exception can be due to not supported. public VoiceCommand() { SafeCommandHandle handle; @@ -88,7 +88,7 @@ namespace Tizen.Uix.VoiceControl /// /// Gets the unfixed command. /// This property should be used for commands which have non-fixed format. - /// empty string will be returned in case of some internal error + /// An empty string will be returned in case of some internal error. /// /// 3 public string UnfixedCommand @@ -108,12 +108,12 @@ namespace Tizen.Uix.VoiceControl } /// - /// Gets/Sets command type. + /// Gets or sets the command type. /// /// 3 - /// If you do not set the command type, the default value is Undefined. You should set type if command is valid - /// This Exception can be due to Permission Denied. - /// This Exception can be due to Not Supported. + /// If you do not set the command type, the default value is undefined. You should set the type if the command is valid. + /// This exception can be due to permission denied. + /// This exception can be due to not supported. public CommandType Type { get @@ -145,12 +145,12 @@ namespace Tizen.Uix.VoiceControl } /// - /// Gets/Sets the command format. + /// Gets or sets the command format. /// /// 3 - /// The default format is Fixed - /// This Exception can be due to Permission Denied. - /// This Exception can be due to Not Supported. + /// The default format is Fixed. + /// This exception can be due to permission denied. + /// This exception can be due to not supported. public CommandFormat Format { get @@ -176,12 +176,12 @@ namespace Tizen.Uix.VoiceControl } /// - /// Gets/Sets command - /// in case of get empty string will be returned in case of some internal error + /// Gets or sets the command. + /// A get empty string will be returned in case of some internal error. /// /// 3 - /// This Exception can be due to Permission Denied. - /// This Exception can be due to Not Supported. + /// This exception can be due to permission denied. + /// This exception can be due to not supported. public string Command { get diff --git a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceCommandList.cs b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceCommandList.cs index f3b962f..2f78277 100755 --- a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceCommandList.cs +++ b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceCommandList.cs @@ -22,7 +22,7 @@ using static Interop.VoiceControlCommand; namespace Tizen.Uix.VoiceControl { /// - /// this class represents list of Voice Commands + /// This class represents a list of the voice commands. /// /// 3 public class VoiceCommandList @@ -32,7 +32,7 @@ namespace Tizen.Uix.VoiceControl private VcCmdListCb _callback; /// - /// Public Constructor + /// The public constructor. /// /// 3 /// @@ -45,10 +45,10 @@ namespace Tizen.Uix.VoiceControl /// http://tizen.org/feature/speech.control /// http://tizen.org/feature/microphone /// - /// This Exception can be due to Out of memory. - /// This Exception can be due to Invalid Parameter. - /// This Exception can be due to Permission Denied. - /// This Exception can be due to Not Supported. + /// This exception can be due to out of memory. + /// This exception can be due to an invalid parameter. + /// This exception can be due to permission denied. + /// This exception can be due to not supported. public VoiceCommandList() { SafeCommandListHandle handle; @@ -67,12 +67,12 @@ namespace Tizen.Uix.VoiceControl } /// - /// Gets command count of list. - /// -1 is returned in case of internal failure. + /// Gets a command count of the list. + /// -1 is returned in case of an internal failure. /// /// 3 /// - /// Command counts of the list. + /// Command count of the list. /// /// /// http://tizen.org/privilege/recorder @@ -97,8 +97,8 @@ namespace Tizen.Uix.VoiceControl } /// - /// Get current command from command list by index. - /// null will be returned in case of Empty List + /// Gets the current command from the command list by index. + /// Null will be returned in case of an empty list. /// /// 3 /// @@ -127,7 +127,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// Adds command to command list. + /// Adds a command to the command list. /// /// 3 /// @@ -141,9 +141,9 @@ namespace Tizen.Uix.VoiceControl /// http://tizen.org/feature/microphone /// /// The command - /// This Exception can be due to Permission Denied. - /// This Exception can be due to Not Supported. - /// This will occur if the provide parameter is null. + /// This exception can be due to permission denied. + /// This exception can be due to not supported. + /// This will occur if the provided parameter is null. public void Add(VoiceCommand command) { ErrorCode error = VcCmdListAdd(_handle, command._handle); @@ -155,7 +155,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// Removes command from command list. + /// Removes a command from the command list. /// /// 3 /// @@ -169,9 +169,9 @@ namespace Tizen.Uix.VoiceControl /// http://tizen.org/feature/microphone /// /// The command - /// This Exception can be due to Permission Denied. - /// This Exception can be due to Not Supported. - /// This will occur if the provide parameter is null. + /// This exception can be due to permission denied. + /// This exception can be due to not supported. + /// This will occur if the provided parameter is null. public void Remove(VoiceCommand command) { ErrorCode error = VcCmdListRemove(_handle, command._handle); @@ -183,7 +183,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// Retrieves all commands of command list. + /// Retrieves all commands from the command list. /// /// 3 /// @@ -196,8 +196,8 @@ namespace Tizen.Uix.VoiceControl /// http://tizen.org/feature/speech.control /// http://tizen.org/feature/microphone /// - /// This Exception can be due to Permission Denied. - /// This Exception can be due to Not Supported. + /// This exception can be due to permission denied. + /// This exception can be due to not supported. public IEnumerable GetAllCommands() { _list = new List(); @@ -219,7 +219,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// Moves index to first command. + /// Moves an index to the first command. /// /// 3 /// @@ -232,9 +232,9 @@ namespace Tizen.Uix.VoiceControl /// http://tizen.org/feature/speech.control /// http://tizen.org/feature/microphone /// - /// This Exception can be due to List Empty. - /// This Exception can be due to Permission Denied. - /// This Exception can be due to Not Supported. + /// This exception can be due to list empty. + /// This exception can be due to permission denied. + /// This exception can be due to not supported. public void First() { ErrorCode error = VcCmdListFirst(_handle); @@ -246,7 +246,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// Moves index to last command. + /// Moves an index to the last command. /// /// 3 /// @@ -259,9 +259,9 @@ namespace Tizen.Uix.VoiceControl /// http://tizen.org/feature/speech.control /// http://tizen.org/feature/microphone /// - /// This Exception can be due to List Empty. - /// This Exception can be due to Permission Denied. - /// This Exception can be due to Not Supported. + /// This exception can be due to list empty. + /// This exception can be due to permission denied. + /// This exception can be due to not supported. public void Last() { ErrorCode error = VcCmdListLast(_handle); @@ -273,7 +273,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// Moves index to next command. + /// Moves an index to the next command. /// /// 3 /// @@ -287,12 +287,12 @@ namespace Tizen.Uix.VoiceControl /// http://tizen.org/feature/microphone /// /// - /// This Exception can be due to the following reaons - /// 1. List Empty + /// This exception can be due to the following reasons: + /// 1. List empty /// 2. List reached end /// - /// This Exception can be due to Permission Denied. - /// This Exception can be due to Not Supported. + /// This exception can be due to permission denied. + /// This exception can be due to not supported. public void Next() { ErrorCode error = VcCmdListNext(_handle); @@ -304,7 +304,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// Moves index to previous command. + /// Moves an index to the previous command. /// /// 3 /// @@ -318,12 +318,12 @@ namespace Tizen.Uix.VoiceControl /// http://tizen.org/feature/microphone /// /// - /// This Exception can be due to the following reaons - /// 1. List Empty + /// This exception can be due to the following reasons: + /// 1. List empty /// 2. List reached end /// - /// This Exception can be due to Permission Denied. - /// This Exception can be due to Not Supported. + /// This exception can be due to permission denied. + /// This exception can be due to not supported. public void Previous() { ErrorCode error = VcCmdListPrev(_handle); diff --git a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceControlClient.cs b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceControlClient.cs index 4b8638d..29baf36 100755 --- a/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceControlClient.cs +++ b/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceControlClient.cs @@ -23,85 +23,85 @@ using static Interop.VoiceControlCommand; namespace Tizen.Uix.VoiceControl { /// - /// 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. /// None, /// - /// Out of Memory + /// Out of memory. /// OutOfMemory, /// - /// I/O error + /// I/O error. /// IoError, /// - /// Invalid parameter + /// Invalid parameter. /// InvalidParameter, /// - /// No answer from the STT service + /// No answer from the STT service. /// TimedOut, /// - /// Device or resource busy + /// Device or resource busy. /// RecorderBusy, /// - /// Permission denied + /// Permission denied. /// PermissionDenied, /// - /// VC NOT supported + /// VC NOT supported. /// NotSupported, /// - /// Invalid state + /// Invalid state. /// InvalidState, /// - /// Invalid language + /// Invalid language. /// InvalidLanguage, /// - /// No available engine + /// No available engine. /// EngineNotFound, /// - /// Operation failed + /// Operation failed. /// OperationFailed, /// - /// Operation Rejected + /// Operation rejected. /// OperationRejected, /// - /// List reached end + /// List reached end. /// IterationEnd, /// - /// List Empty + /// List empty. /// Empty, /// - /// Service reset + /// Service reset. /// ServiceReset, /// - /// Progress to ready is not finished + /// Progress to ready is not finished. /// InProgressToReady, /// - /// Progress to recording is not finished + /// Progress to recording is not finished. /// InProgressToRecording, /// - /// Progress to processing is not finished + /// Progress to processing is not finished. /// InProgressToProcessing }; @@ -113,105 +113,105 @@ namespace Tizen.Uix.VoiceControl public enum State { /// - /// 'None' state + /// 'None' state. /// None = 0, /// - /// 'Initialized' state + /// 'Initialized' state. /// Initialized = 1, /// - /// 'Ready' state + /// 'Ready' state. /// Ready = 2, /// - /// state cannot be determined + /// The state cannot be determined. /// Unavailable }; /// - /// Enumerations of service state. + /// Enumeration for the service state. /// /// 3 public enum ServiceState { /// - /// 'None' state + /// 'None' state. /// None = 0, /// - /// 'Ready' state + /// 'Ready' state. /// Ready = 1, /// - /// 'Recording' state + /// 'Recording' state. /// Recording = 2, /// - /// 'Processing' state + /// 'Processing' state. /// Processing = 3, /// - /// state cannot be determined + /// The state cannot be determined. /// Unavailable }; /// - /// Enumerations of result event. + /// Enumeration for the result event. /// /// 3 public enum ResultEvent { /// - /// Normal result + /// Normal result. /// Success = 0, /// - /// Rejected result + /// Rejected result. /// Rejected = 1 }; /// - /// Enumerations of command type. + /// Enumeration for the command type. /// /// 3 public enum CommandType { /// - /// Foreground command by client + /// Foreground command by the client. /// Foreground = 1, /// - /// Background command by client + /// Background command by the client. /// Background = 2, /// - /// Undefined command + /// The undefined command. /// Undefined = -1 }; /// - /// A main function of Voice Control API register command and gets notification for recognition result. - /// Applications can add their own commands and be provided result when their command is recognized by user voice input. + /// A main function of the voice control API registers the command and gets a notification for the recognition result. + /// Applications can add their own commands and provide results when their command is recognized by the user voice input. /// /// 3 public static class VoiceControlClient { /// - /// Called when client gets the recognition result. + /// Called when a client gets the recognition result. /// /// 3 /// - /// If the duplicated commands are recognized, the event(e.g. Result.Rejected) of command may be rejected - /// for selecting command as priority.If you set similar or same commands or the recognized results are multi-results, cmdList has the multi commands. + /// If the duplicated commands are recognized, the event(for example, Result.Rejected) of a command may be rejected + /// for selecting the command as a priority. If you set similar or same commands, or the recognized results are multi-results, the cmdList has multi-commands. /// - /// The ResultEvent - /// Command List - /// Result + /// The ResultEvent. + /// Command List. + /// Result. private static event EventHandler _recognitionResult; private static event EventHandler _stateChanged; @@ -229,21 +229,21 @@ namespace Tizen.Uix.VoiceControl private static RecognitionResult s_recognitionResult; /// - /// Gets current language. + /// Gets the current language. /// A 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. - /// Empty string is returned incase of some internal error + /// An empty string is returned in case of some internal error. /// /// 3 /// - /// Current language in voice control. + /// The current language in voice control. /// /// /// http://tizen.org/privilege/recorder /// /// 
-        /// The State must be Initialized or Ready.
+        /// The state must be initialized or ready.
         ///
public static string CurrentLanguage { @@ -263,17 +263,17 @@ namespace Tizen.Uix.VoiceControl } /// - /// Gets current state of voice control client. + /// Gets the current state of the voice control client. /// /// 3 /// - /// Current state of voice control client. + /// The current state of the voice control client. /// /// /// http://tizen.org/privilege/recorder /// /// 
-        /// The State must be Initialized or Ready.
+        /// The state must be initialized or ready.
         ///
public static State State { @@ -293,17 +293,17 @@ namespace Tizen.Uix.VoiceControl } /// - /// Gets current state of voice control service. + /// Gets the current state of the voice control service. /// /// 3 /// - /// Current state of voice control service. + /// The current state of the voice control service. /// /// /// http://tizen.org/privilege/recorder /// /// 
-        /// The State must be Ready.
+        /// The state must be ready.
         ///
public static ServiceState ServiceState { @@ -337,20 +337,20 @@ namespace Tizen.Uix.VoiceControl /// http://tizen.org/feature/microphone /// /// - /// Invocation name is used to activate background commands. The invocation name can be the same as the application name or any other phrase. + /// The invocation name is used to activate background commands. The invocation name can be same as the application name or any other phrase. /// For example, an application "Tizen Sample" has a background command, "Play music", and the invocation name of the application is set to "Tizen Sample". /// In order to activate the background command, users can say "Tizen Sample, Play music". The invocation name is dependent on the current language. /// For example, if the current language is "en_US"(English), the invocation name is also "en_US". /// If the current language is "ja_JP"(Japanese) and the invocation name is "en_US", the invocation name will not be recognized. - /// This function should be called before SetCommandList(). + /// This function should be called before the SetCommandList(). /// - /// Invocation name that an application wants to be invoked by - /// This Exception can be due to Invalid State. - /// This Exception can be due to Invalid Parameter. - /// This Exception can be due to Not Supported. - /// This Exception can be due to Permission Denied. + /// Invocation name to be invoked by an application. + /// This exception can be due to an invalid state. + /// This exception can be due to an invalid parameter. + /// This exception can be due to not supported. + /// This exception can be due to permission denied. /// 
-        /// The State must be Ready.
+        /// The state must be ready.
         ///
public static void SetInvocationName(string name) { @@ -363,7 +363,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// Initializes voice control. + /// Initializes the voice control. /// /// 3 /// @@ -376,12 +376,12 @@ namespace Tizen.Uix.VoiceControl /// http://tizen.org/feature/speech.control /// 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 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 not supported. + /// This exception can be due to permission denied. /// - /// The State will be Initialized. + /// The state will be initialized. /// public static void Initialize() { @@ -394,7 +394,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// Deinitializes voice control. + /// Deinitializes the voice control. /// /// 3 /// @@ -407,10 +407,10 @@ namespace Tizen.Uix.VoiceControl /// http://tizen.org/feature/speech.control /// http://tizen.org/feature/microphone /// - /// This Exception can be due to Invalid State. - /// This Exception can be due to Operation Failed. - /// This Exception can be due to Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to an invalid state. + /// This exception can be due to operation failed. + /// This exception can be due to not supported. + /// This exception can be due to permission denied. public static void Deinitialize() { ErrorCode error = VcDeinitialize(); @@ -435,15 +435,15 @@ namespace Tizen.Uix.VoiceControl /// http://tizen.org/feature/speech.control /// http://tizen.org/feature/microphone /// - /// This Exception can be due to Invalid State. - /// This Exception can be due to Operation Failed. - /// This Exception can be due to Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to an invalid state. + /// This exception can be due to operation failed. + /// This exception can be due to not supported. + /// This exception can be due to permission denied. /// 
-        /// The State should be Initialized
+        /// The state must be initialized.
         ///
/// - /// The State will be Ready + /// The state must be ready. /// public static void Prepare() { @@ -469,14 +469,14 @@ namespace Tizen.Uix.VoiceControl /// http://tizen.org/feature/speech.control /// http://tizen.org/feature/microphone /// - /// This Exception can be due to Invalid State. - /// This Exception can be due to Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to an invalid state. + /// This exception can be due to not supported. + /// This exception can be due to permission denied. /// 
-        /// The State should be Ready
+        /// The state must be ready.
         ///
/// - /// The State should be Initialized + /// The state must be initialized. /// public static void Unprepare() { @@ -489,7 +489,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// Retrieves all supported languages. + /// Retrieves all the supported languages. /// A 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. @@ -505,12 +505,12 @@ namespace Tizen.Uix.VoiceControl /// http://tizen.org/feature/speech.control /// http://tizen.org/feature/microphone /// - /// This Exception can be due to Invalid State. - /// This Exception can be due to Operation Failed. - /// This Exception can be due to Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to an invalid state. + /// This exception can be due to operation failed. + /// This exception can be due to not supported. + /// This exception can be due to permission denied. /// 
-        /// The State should be Ready or Initialized
+        /// The state must be ready or initialized.
         ///
public static IEnumerable GetSupportedLanguages() { @@ -536,13 +536,13 @@ namespace Tizen.Uix.VoiceControl /// /// 3 /// - /// The Command List else null in case of no System Commands + /// The command list, else null in case of no system commands. /// /// /// http://tizen.org/privilege/recorder /// /// - /// public + /// public. /// /// /// http://tizen.org/feature/speech.control @@ -550,14 +550,14 @@ namespace Tizen.Uix.VoiceControl /// /// /// In the system command list, there are system commands predefined by product manufacturers. - /// Those commands have the highest priority. Therefore, the user can not set any commands same with the system commands. + /// Those commands have the highest priority. Therefore, the user cannot set any commands similar to system commands. /// - /// This Exception can be due to Invalid State. - /// This Exception can be due to Operation Failed. - /// This Exception can be due to Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to an invalid state. + /// This exception can be due to operation failed. + /// This exception can be due to not supported. + /// This exception can be due to permission denied. /// 
-        /// The State should be Ready
+        /// The state must be ready.
         ///
public static VoiceCommandList GetSystemCommandList() { @@ -581,11 +581,11 @@ namespace Tizen.Uix.VoiceControl /// /// Requests to start the dialogue. - /// Using this function, the developer can request starting the dialogue to the framework. - /// When the developer requests the dialogue, two types of texts, dispText and uttText, can be sent by this function.dispText is a text for displaying, and uttText is that for uttering. + /// By using this function, the developer can start requesting the dialogue to the framework. + /// When the developer requests the dialogue, two types of texts, dispText and uttText can be sent by this function. dispText is a text for displaying and uttText is that for uttering. /// For example, if dispText is "October 10th" and uttText is "Today is October 10th.", "October 10th" will be displayed on the screen and "Today is October 10th." will be spoken. /// Also, the developer can set whether the dialogue starts automatically or not, using autoStart. - /// If the developer sets autoStart as true, the framework will start to record next speech and continue the dialogue. + /// If the developer sets autoStart as True, the framework will start to record the next speech and continue the dialogue. /// /// 3 /// @@ -599,17 +599,17 @@ namespace Tizen.Uix.VoiceControl /// http://tizen.org/feature/microphone /// /// - /// If autoStart is true, the recognition will start again. In this case, it can be restarted up to 4 times. + /// If autoStart is True, the recognition will start again. In this case, it can be restarted up to 4 times. /// - /// Text to be displayed on the screen/// - /// Text to be spoken - /// A variable for setting whether the dialog session will be restarted automatically or not - /// This Exception can be due to Invalid State. - /// This Exception can be due to Invalid Parameter. - /// This Exception can be due to Not Supported. - /// This Exception can be due to Permission Denied. + /// Text to be displayed on the screen. + /// Text to be spoken. + /// A variable for setting whether the dialog session will be restarted automatically or not. + /// This exception can be due to an invalid state. + /// This exception can be due to an invalid parameter. + /// This exception can be due to not supported. + /// This exception can be due to permission denied. /// 
-        /// The State should be Ready
+        /// The state must be ready.
         ///
public static void RequestDialog(string dispText, string uttText, bool autoStart) { @@ -622,7 +622,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// Sets command list. + /// Sets the command list. /// /// 3 /// @@ -637,16 +637,16 @@ namespace Tizen.Uix.VoiceControl /// /// /// The command type is valid for CommandType 'Foreground' or 'Background'. - /// The matched commands of command list should be set and they should include type and command text at least. + /// The matched commands of the command list should be set and they should include type and command text at least. /// /// Command list /// Command type - /// This Exception can be due to Invalid State. - /// This Exception can be due to Invalid Parameter. - /// This Exception can be due to Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to an invalid state. + /// This exception can be due to an invalid parameter. + /// This exception can be due to not supported. + /// This exception can be due to permission denied. /// 
-        /// The State should be Ready
+        /// The state must be ready.
         ///
public static void SetCommandList(VoiceCommandList list, CommandType type) { @@ -667,7 +667,7 @@ namespace Tizen.Uix.VoiceControl } /// - /// Unsets command list. + /// Unsets the command list. /// /// 3 /// @@ -681,12 +681,12 @@ namespace Tizen.Uix.VoiceControl /// http://tizen.org/feature/microphone /// /// Command type - /// This Exception can be due to Invalid State. - /// This Exception can be due to Invalid Parameter. - /// This Exception can be due to Not Supported. - /// This Exception can be due to Permission Denied. + /// This exception can be due to an invalid state. + /// This exception can be due to an invalid parameter. + /// This exception can be due to not supported. + /// This exception can be due to permission denied. /// 
-        /// The State should be Ready
+        /// The state should be ready.
         ///
public static void UnsetCommandList(CommandType type) { @@ -723,12 +723,12 @@ namespace Tizen.Uix.VoiceControl /// http://tizen.org/feature/speech.control /// http://tizen.org/feature/microphone /// - /// This Exception can be due to Invalid State. - /// This Exception can be due to Invalid Parameter. - /// This Exception can be due to Not Supported. - /// The Recognition Result if possible else a null object + /// This exception can be due to an invalid state. + /// This exception can be due to an invalid parameter. + /// This exception can be due to not supported. + /// The recognition result if possible, else a null object. /// 
-        /// The State should be Ready
+        /// The state must be ready.
         ///
public static RecognitionResult GetResult() { @@ -752,7 +752,7 @@ namespace Tizen.Uix.VoiceControl /// /// 3 /// 
-        /// The State should be Initialized
+        /// The state must be initialized.
         ///
public static event EventHandler RecognitionResult { @@ -795,11 +795,11 @@ namespace Tizen.Uix.VoiceControl } /// - /// Event to be invoked when VoiceControl service state changes. + /// Event to be invoked when the VoiceControl service state changes. /// /// 3 /// 
-        /// The State should be Initialized
+        /// The state must be initialized.
         ///
public static event EventHandler ServiceStateChanged { @@ -834,11 +834,11 @@ namespace Tizen.Uix.VoiceControl } /// - /// Event to be invoked when VoiceControl client state changes. + /// Event to be invoked when the VoiceControl client state changes. /// /// 3 /// 
-        /// The State should be Initialized
+        /// The state must be initialized.
         ///
public static event EventHandler StateChanged { @@ -877,7 +877,7 @@ namespace Tizen.Uix.VoiceControl /// /// 3 /// 
-        /// The State should be Initialized
+        /// The state must be initialized.
         ///
public static event EventHandler ErrorOccured { @@ -914,11 +914,11 @@ namespace Tizen.Uix.VoiceControl } /// - /// Event to be invoked when default laungage change. + /// Event to be invoked when the default language changes. /// /// 3 /// 
-        /// The State should be Initialized
+        /// The state must be initialized.
         ///
public static event EventHandler CurrentLanguageChanged { -- 2.34.1