From 7f0618cd51ad766607e0e1dc28f98c23099a76c7 Mon Sep 17 00:00:00 2001 From: Editor Date: Thu, 28 Dec 2017 15:13:26 +0530 Subject: [PATCH] Review Uix.InputMethod/SttEngine/TtsEngine API cs files Change-Id: If080c95ab5c0d6db63d5f1813e5d77375c07e645 --- .../Interop/Interop.EinaList.cs | 4 +- .../Interop/Interop.InputMethod.cs | 4 +- .../Interop/Interop.Libraries.cs | 4 +- .../AccessibilityStateChangedEventArgs.cs | 4 +- .../CursorPositionUpdatedEventArgs.cs | 4 +- .../Tizen.Uix.InputMethod/DataSetEventArgs.cs | 6 +- .../DisplayLanguageChangedEventArgs.cs | 4 +- .../Tizen.Uix.InputMethod/EditorWindow.cs | 18 +- .../Tizen.Uix.InputMethod/FocusedInEventArgs.cs | 4 +- .../Tizen.Uix.InputMethod/FocusedOutEventArgs.cs | 4 +- .../Tizen.Uix.InputMethod/InputMethodContext.cs | 122 ++-- .../InputMethodDeviceInformation.cs | 48 +- .../Tizen.Uix.InputMethod/InputMethodEditor.cs | 660 ++++++++++----------- .../LanguageSetSetEventArgs.cs | 4 +- .../Tizen.Uix.InputMethod/LayoutSetEventArgs.cs | 4 +- .../Tizen.Uix.InputMethod/PreEditAttribute.cs | 16 +- .../ReturnKeyStateSetEventArgs.cs | 4 +- .../ReturnKeyTypeSetEventArgs.cs | 4 +- .../RotationChangedEventArgs.cs | 4 +- .../SurroundingTextUpdatedArgs.cs | 8 +- .../Interop/Interop.Libraries.cs | 4 +- .../Interop/Interop.SttEngine.cs | 4 +- .../Tizen.Uix.SttEngine/SttEngine.cs | 370 ++++++------ .../Interop/Interop.Libraries.cs | 4 +- .../Interop/Interop.TtsEngine.cs | 4 +- .../Tizen.Uix.TtsEngine/TtsEngine.cs | 302 +++++----- 26 files changed, 809 insertions(+), 809 deletions(-) diff --git a/src/Tizen.Uix.InputMethod/Interop/Interop.EinaList.cs b/src/Tizen.Uix.InputMethod/Interop/Interop.EinaList.cs index 50a64ad..27cfe74 100755 --- a/src/Tizen.Uix.InputMethod/Interop/Interop.EinaList.cs +++ b/src/Tizen.Uix.InputMethod/Interop/Interop.EinaList.cs @@ -20,12 +20,12 @@ using System.Runtime.InteropServices; using Tizen.Uix.InputMethod; /// -/// Partial Interop Class +/// The Partial Interop class. /// internal static partial class Interop { /// - /// EinaList Interop Class + /// The EinaList Interop class. /// internal static class EinaList { diff --git a/src/Tizen.Uix.InputMethod/Interop/Interop.InputMethod.cs b/src/Tizen.Uix.InputMethod/Interop/Interop.InputMethod.cs index 79eaee8..cf90bac 100755 --- a/src/Tizen.Uix.InputMethod/Interop/Interop.InputMethod.cs +++ b/src/Tizen.Uix.InputMethod/Interop/Interop.InputMethod.cs @@ -20,12 +20,12 @@ using System.Runtime.InteropServices; using Tizen.Uix.InputMethod; /// -/// Partial Interop Class +/// The Partial Interop class. /// internal static partial class Interop { /// - /// InputMethod Interop Class + /// The InputMethod Interop class. /// internal static class InputMethod { diff --git a/src/Tizen.Uix.InputMethod/Interop/Interop.Libraries.cs b/src/Tizen.Uix.InputMethod/Interop/Interop.Libraries.cs index 888641a..8e7266d 100755 --- a/src/Tizen.Uix.InputMethod/Interop/Interop.Libraries.cs +++ b/src/Tizen.Uix.InputMethod/Interop/Interop.Libraries.cs @@ -16,12 +16,12 @@ /// -/// Partial Interop Class +/// The Partial Interop class. /// internal static partial class Interop { /// - /// Partial Libraries Class + /// The Partial Libraries class. /// internal static partial class Libraries { diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/AccessibilityStateChangedEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/AccessibilityStateChangedEventArgs.cs index d772cd3..e690fcf 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/AccessibilityStateChangedEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/AccessibilityStateChangedEventArgs.cs @@ -17,7 +17,7 @@ namespace Tizen.Uix.InputMethod { /// - /// This Class contains data related to AccessibilityStateChanged Event + /// This class contains the data related to the AccessibilityStateChanged event. /// /// 4 public class AccessibilityStateChangedEventArgs @@ -28,7 +28,7 @@ namespace Tizen.Uix.InputMethod } /// - /// Accessibility option state + /// Accessibility option state. /// /// 4 public bool State diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/CursorPositionUpdatedEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/CursorPositionUpdatedEventArgs.cs index d21c828..81e08a6 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/CursorPositionUpdatedEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/CursorPositionUpdatedEventArgs.cs @@ -17,7 +17,7 @@ namespace Tizen.Uix.InputMethod { /// - /// This Class contains data related to CursorPositionUpdated Event + /// This class contains the data related to the CursorPositionUpdated event. /// /// 4 public class CursorPositionUpdatedEventArgs @@ -28,7 +28,7 @@ namespace Tizen.Uix.InputMethod } /// - /// The cursor position + /// The cursor position. /// /// 4 public int CursorPosition diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DataSetEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DataSetEventArgs.cs index 7a80346..c8fecb9 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DataSetEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DataSetEventArgs.cs @@ -17,7 +17,7 @@ namespace Tizen.Uix.InputMethod { /// - /// This Class contains data related to DataSet Event + /// This class contains the data related to the DataSet event. /// /// 4 public class SetDataEventArgs @@ -29,7 +29,7 @@ namespace Tizen.Uix.InputMethod } /// - /// The specific data to be set to the input panel + /// The specific data to be set to the input panel. /// /// 4 public byte[] Data @@ -39,7 +39,7 @@ namespace Tizen.Uix.InputMethod } /// - /// The length of data, in bytes, to send to the input panel + /// The length of data, in bytes, to be sent to the input panel. /// /// 4 public uint DataLength diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DisplayLanguageChangedEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DisplayLanguageChangedEventArgs.cs index 9295fa5..8a76191 100644 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DisplayLanguageChangedEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DisplayLanguageChangedEventArgs.cs @@ -17,7 +17,7 @@ namespace Tizen.Uix.InputMethod { /// - /// This Class contains data related to DisplayLanguageChanged Event + /// This class contains the data related to the DisplayLanguageChanged event. /// /// 4 public class DisplayLanguageChangedEventArgs @@ -28,7 +28,7 @@ namespace Tizen.Uix.InputMethod } /// - /// The language code + /// The language code. /// /// 4 public string Language diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/EditorWindow.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/EditorWindow.cs index 4dff275..279354b 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/EditorWindow.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/EditorWindow.cs @@ -22,7 +22,7 @@ using static Interop.InputMethod; namespace Tizen.Uix.InputMethod { /// - /// The Editor window class + /// The editor window class. /// /// 4 public class EditorWindow : Window @@ -36,7 +36,7 @@ namespace Tizen.Uix.InputMethod } /// - /// This API creates handle for editor window. + /// This API creates a handle for the editor window. /// /// 4 protected override IntPtr CreateHandle(EvasObject parent) @@ -45,7 +45,7 @@ namespace Tizen.Uix.InputMethod } /// - /// This API gets handle for editor window. + /// This API gets a handle for the editor window. /// /// 4 public IntPtr GetHandle() @@ -59,14 +59,14 @@ namespace Tizen.Uix.InputMethod /// /// http://tizen.org/privilege/ime /// - /// The width in portrait mode - /// The height in portrait mode - /// The width in landscape mode - /// The height in landscape mode + /// The width in the portrait mode. + /// The height in the portrait mode. + /// The width in the landscape mode. + /// The height in the landscape mode. /// /// This can occur due to the following reasons: - /// 1) The application does not have the privilege to call this function - /// 2) IME main loop isn't started yet + /// 1) The application does not have the privilege to call this function. + /// 2) The IME main loop isn't started yet. /// /// 4 public static void SetSize(int portraitWidth, int portraitHeight, int landscapeWidth, int landscapeHeight) diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/FocusedInEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/FocusedInEventArgs.cs index cd7741c..6264953 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/FocusedInEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/FocusedInEventArgs.cs @@ -17,7 +17,7 @@ namespace Tizen.Uix.InputMethod { /// - /// This Class contains data related to FocusedIn Event + /// This class contains the data related to the FocusedIn event. /// /// 4 public class FocusedInEventArgs @@ -28,7 +28,7 @@ namespace Tizen.Uix.InputMethod } /// - /// The input context identification value of an associated text input UI control + /// The input context identification value of an associated text input UI control. /// /// 4 public int ContextId diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/FocusedOutEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/FocusedOutEventArgs.cs index 013f7c6..0bc7232 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/FocusedOutEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/FocusedOutEventArgs.cs @@ -17,7 +17,7 @@ namespace Tizen.Uix.InputMethod { /// - /// This Class contains data related to FocusedOut Event + /// This class contains the data related to the FocusedOut event. /// /// 4 public class FocusedOutEventArgs @@ -28,7 +28,7 @@ namespace Tizen.Uix.InputMethod } /// - /// The input context identification value of an associated text input UI control + /// The input context identification value of an associated text input UI control. /// /// 4 public int ContextId diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodContext.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodContext.cs index f9d8fd4..1e911fb 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodContext.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodContext.cs @@ -21,275 +21,275 @@ using static Interop.InputMethod; namespace Tizen.Uix.InputMethod { /// - /// Enumeration for Input Panel Layout + /// Enumeration for the input panel layout. /// /// 4 public enum InputPanelLayout { /// - /// Normal + /// Normal. /// LayoutNormal, /// - /// Number + /// Number. /// LayoutNumber, /// - /// Email + /// Email. /// LayoutEMail, /// - /// URL + /// URL. /// LayoutURL, /// - /// Phone Number + /// Phone Number. /// LayoutPhoneNumber, /// - /// IP + /// IP. /// LayoutIP, /// - /// Month + /// Month. /// LayoutMonth, /// - /// Number Only + /// Number Only. /// LayoutNumberOnly, /// - /// Invalid + /// Invalid. /// LayoutInvalid, /// - /// HEX + /// HEX. /// LayoutHEX, /// - /// Terminal + /// Terminal. /// LayoutTerminal, /// - /// Password + /// Password. /// LayoutPassword, /// - /// Date Time + /// Date and time. /// LayoutDateTime, /// - /// Emoticon + /// Emoticon. /// LayoutEmoticon, /// - /// Voice + /// Voice. /// LayoutVoice, /// - /// Undefined + /// Undefined. /// Undefined }; /// - /// Enumeration for Layout Variation + /// Enumeration for the layout variation. /// /// 4 public enum LayoutVariation { /// - /// The plain normal layout + /// The plain normal layout. /// NormalNormal = 0, /// - /// Filename layout; symbols such as '/', '\*', '\', '|', '<', '>', '?', '"' and ':' should be disabled + /// Filename layout; symbols such as '/', '\*', '\', '|', '<', '>', '?', '"', and ':' should be disabled. /// NormalFileName, /// - /// The name of a person + /// The name of a person. /// NormalPersonName, /// - /// The plain normal number layout + /// The plain normal number layout. /// NumberOnlyNormal = 0, /// - /// The number layout to allow a negative sign + /// The number layout to allow a negative sign. /// NumberOnlySigned, /// - /// The number layout to allow decimal point to provide fractional value + /// The number layout to allow a decimal point to provide fractional value. /// NumberOnlyDecimal, /// - /// The number layout to allow decimal point and negative sign + /// The number layout to allow a decimal point and negative sign. /// NumberOnlySignedAndDecimal, /// - /// The normal password layout + /// The normal password layout. /// PasswordNormal = 0, /// - /// The password layout to allow only number + /// The password layout to allow only a number. /// PasswordNumberOnly, /// - /// Undefined + /// Undefined. /// Undefined }; /// - /// Enumeration for AutoCapital Type + /// Enumeration for the AutoCapital types. /// /// 4 public enum AutoCapitalization { /// - /// None + /// None. /// None, /// - /// Word + /// Word. /// Word, /// - /// Sentence + /// Sentence. /// Sentence, /// - /// All Character + /// All characters. /// AllCharacter, /// - /// Undefined + /// Undefined. /// Undefined }; /// - /// Enumeration for InputPanel ReturnKey Type + /// Enumeration for the InputPanel ReturnKey types. /// /// 4 public enum InputPanelReturnKey { /// - /// Default + /// Default. /// Default, /// - /// Done + /// Done. /// Done, /// - /// Go + /// Go. /// Go, /// - /// Join + /// Join. /// Join, /// - /// Login + /// Login. /// Login, /// - /// Next + /// Next. /// Next, /// - /// Search + /// Search. /// Search, /// - /// Send + /// Send. /// Send, /// - /// SignIn + /// SignIn. /// SignIn, /// - /// Undefined + /// Undefined. /// Undefined }; /// - /// Enumeration for InputHints + /// Enumeration for the InputHints. /// /// 4 public enum InputHints { /// - /// None + /// None. /// None, /// - /// AutoComplete + /// AutoComplete. /// AutoComplete, /// - /// SensitiveData + /// SensitiveData. /// SensitiveData, /// - /// Multiline + /// Multiline. /// Multiline, /// - /// Undefined + /// Undefined. /// Undefined }; /// - /// Enumeration for BiDi Direction + /// Enumeration for the BiDirection. /// /// 4 public enum BiDirection { /// - /// Neutral + /// Neutral. /// Neutral, /// - /// LTR + /// LTR. /// LTR, /// - /// RTL + /// RTL. /// RTL, /// - /// Undefined + /// Undefined. /// Undefined }; /// - /// Enumeration for InputPanel Language + /// Enumeration for the InputPanel language. /// /// 4 public enum InputPanelLanguage { /// - /// Automatic + /// Automatic. /// Automatic, /// - /// Alphabet + /// Alphabet. /// Alphabet, /// - /// Undefined + /// Undefined. /// Undefined }; /// - /// This class represents the context of InputMethodEditor + /// This class represents the context of the InputMethodEditor. /// /// 4 public class InputMethodContext diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodDeviceInformation.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodDeviceInformation.cs index a706d64..72c29ee 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodDeviceInformation.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodDeviceInformation.cs @@ -22,107 +22,107 @@ using static Interop.InputMethod; namespace Tizen.Uix.InputMethod { /// - /// Enumeration for Device Class + /// Enumeration for the device class. /// /// 4 public enum DeviceClass { /// - /// None + /// None. /// None, /// - /// Seat + /// Seat. /// Seat, /// - /// Keyboard + /// Keyboard. /// Keyboard, /// - /// Mouse + /// Mouse. /// Mouse, /// - /// Touch + /// Touch. /// Touch, /// - /// Pen + /// Pen. /// Pen, /// - /// Pointer + /// Pointer. /// Pointer, /// - /// Gamepad + /// Gamepad. /// Gamepad, /// - /// Undefined + /// Undefined. /// Undefined }; /// - /// Enumeration for Device SubClass + /// Enumeration for the device subclass. /// /// 4 public enum DeviceSubclass { /// - /// None + /// None. /// None, /// - /// Finger + /// Finger. /// Finger, /// - /// FingerNail + /// FingerNail. /// FingerNail, /// - /// Knuckle + /// Knuckle. /// Knuckle, /// - /// Palm + /// Palm. /// Palm, /// - /// HandSize + /// HandSize. /// HandSize, /// - /// HandFlat + /// HandFlat. /// HandFlat, /// - /// PenTip + /// PenTip. /// PenTip, /// - /// Trackpad + /// Trackpad. /// Trackpad, /// - /// Trackpoint + /// Trackpoint. /// Trackpoint, /// - /// Trackball + /// Trackball. /// Trackball, /// - /// Undefined + /// Undefined. /// Undefined }; /// - /// this class gives the device information, like the name, class and subclass + /// This class gives the device information, like the name, class, and subclass. /// /// 4 public class InputMethodDeviceInformation diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodEditor.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodEditor.cs index 91f90a1..3e67565 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodEditor.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodEditor.cs @@ -23,938 +23,938 @@ using static Interop.InputMethod; namespace Tizen.Uix.InputMethod { /// - /// Enumeration of the key codes. - /// If keycode & 0xff000000 == 0x01000000 then this key code is directly encoded 24-bit UCS character.The UCS value is keycode & 0x00ffffff. - /// Defines the list of keys supported by the system.Note that certain keys may not be available on all devices. + /// Enumeration for the key codes. + /// If keycode & 0xff000000 == 0x01000000 then this key code is directly encoded to 24-bit UCS character. The UCS value is keycode & 0x00ffffff. + /// Defines the list of keys supported by the system. Note that certain keys may not be available on all the devices. /// /// 4 public enum KeyCode { /// - /// The backspace key + /// The Backspace key. /// BackSpace = 0xFF08, /// - /// The tab key + /// The Tab key. /// Tab = 0xFF09, /// - /// The linefeed key + /// The Linefeed key. /// Linefeed = 0xFF0A, /// - /// The clear key + /// The Clear key. /// Clear = 0xFF0B, /// - /// The return key + /// The Return key. /// Return = 0xFF0D, /// - /// The pause key + /// The Pause key. /// Pause = 0xFF13, /// - /// The scroll lock key + /// The Scroll lock key. /// ScrollLock = 0xFF14, /// - /// The sys req key + /// The System Request key. /// SysReq = 0xFF15, /// - /// The escape key + /// The Escape key. /// Escape = 0xFF1B, /// - /// The delete key + /// The Delete key. /// Delete = 0xFFFF, /* Cursor control & motion */ /// - /// The home key + /// The Home key. /// Home = 0xFF50, /// - /// The left directional key + /// The Left directional key. /// Left = 0xFF51, /// - /// The up directional key + /// The Up directional key. /// Up = 0xFF52, /// - /// The right directional key + /// The Right directional key. /// Right = 0xFF53, /// - /// The down directional key + /// The Down directional key. /// Down = 0xFF54, /// - /// The prior, previous key + /// The Prior, Previous key. /// Prior = 0xFF55, /// - /// The page up key + /// The Page Up key. /// Page_Up = 0xFF55, /// - /// The next key + /// The Next key. /// Next = 0xFF56, /// - /// The page down key + /// The Page Down key. /// Page_Down = 0xFF56, /// - /// The end key + /// The End key. /// End = 0xFF57, /// - /// The begin key + /// The Begin key. /// Begin = 0xFF58, /* Misc Functions */ /// - /// The select key + /// The Select key. /// Select = 0xFF60, /// - /// The print key + /// The Print key. /// Print = 0xFF61, /// - /// The execute, run, do key + /// The Execute, Run, Do key. /// Execute = 0xFF62, /// - /// The insert key + /// The Insert key. /// Insert = 0xFF63, /// - /// The undo key + /// The Undo key. /// Undo = 0xFF65, /// - /// The redo key + /// The Redo key. /// Redo = 0xFF66, /// - /// The menu key + /// The Menu key. /// Menu = 0xFF67, /// - /// The find key + /// The Find key. /// Find = 0xFF68, /// - /// The cancel, stop, abort, exit key + /// The Cancel, Stop, Abort, Exit key. /// Cancel = 0xFF69, /// - /// The help key + /// The Help key. /// Help = 0xFF6A, /// - /// The break key + /// The Break key. /// Break = 0xFF6B, /// - /// The character set switch key + /// The character set switch key. /// Mode_switch = 0xFF7E, /// - /// The num lock key + /// The Number Lock key. /// Num_Lock = 0xFF7F, /* Keypad */ /// - /// The Numpad space key + /// The Numpad Space key. /// KPSpace = 0xFF80, /// - /// The Numpad tab key + /// The Numpad Tab key. /// KPTab = 0xFF89, /// - /// The Numpad enter key + /// The Numpad Enter key. /// KPEnter = 0xFF8D, /// - /// The Numpad function 1 key + /// The Numpad Function 1 key. /// KPF1 = 0xFF91, /// - /// The Numpad function 2 key + /// The Numpad Function 2 key. /// KPF2 = 0xFF92, /// - /// The Numpad function 3 key + /// The Numpad Function 3 key. /// KPF3 = 0xFF93, /// - /// The Numpad function 4 key + /// The Numpad Function 4 key. /// KPF4 = 0xFF94, /// - /// The Numpad home key + /// The Numpad Home key. /// KPHome = 0xFF95, /// - /// The Numpad left key + /// The Numpad Left key. /// KPLeft = 0xFF96, /// - /// The Numpad up key + /// The Numpad Up key. /// KPUp = 0xFF97, /// - /// The Numpad right key + /// The Numpad Right key. /// KPRight = 0xFF98, /// - /// The Numpad down key + /// The Numpad Down key. /// KPDown = 0xFF99, /// - /// The Numpad prior, previous key + /// The Numpad Prior, Previous key. /// KPPrior = 0xFF9A, /// - /// The Numpad page up key + /// The Numpad Page Up key. /// KPPage_Up = 0xFF9A, /// - /// The Numpad next key + /// The Numpad Next key. /// KPNext = 0xFF9B, /// - /// The Numpad page down key + /// The Numpad Page Down key. /// KPPage_Down = 0xFF9B, /// - /// The Numpad end key + /// The Numpad End key. /// KPEnd = 0xFF9C, /// - /// The Numpad begin key + /// The Numpad Begin key. /// KPBegin = 0xFF9D, /// - /// The Numpad insert key + /// The Numpad Insert key. /// KPInsert = 0xFF9E, /// - /// The Numpad delete key + /// The Numpad Delete key. /// KPDelete = 0xFF9F, /// - /// The Numpad equal key + /// The Numpad Equal key. /// KPEqual = 0xFFBD, /// - /// The Numpad multiply key + /// The Numpad Multiply key. /// KPMultiply = 0xFFAA, /// - /// The Numpad add key + /// The Numpad Add key. /// KPAdd = 0xFFAB, /// - /// The Numpad separator key + /// The Numpad Separator key. /// KPSeparator = 0xFFAC, /// - /// The Numpad subtract key + /// The Numpad Subtract key. /// KPSubtract = 0xFFAD, /// - /// The Numpad decimal key + /// The Numpad Decimal key. /// KPDecimal = 0xFFAE, /// - /// The Numpad divide key + /// The Numpad Divide key. /// KPDivide = 0xFFAF, /// - /// The Numpad 0 key + /// The Numpad 0 key. /// KP0 = 0xFFB0, /// - /// The Numpad 1 key + /// The Numpad 1 key. /// KP1 = 0xFFB1, /// - /// The Numpad 2 key + /// The Numpad 2 key. /// KP2 = 0xFFB2, /// - /// The Numpad 3 key + /// The Numpad 3 key. /// KP3 = 0xFFB3, /// - /// The Numpad 4 key + /// The Numpad 4 key. /// KP4 = 0xFFB4, /// - /// The Numpad 5 key + /// The Numpad 5 key. /// KP5 = 0xFFB5, /// - /// The Numpad 6 key + /// The Numpad 6 key. /// KP6 = 0xFFB6, /// - /// The Numpad 7 key + /// The Numpad 7 key. /// KP7 = 0xFFB7, /// - /// The Numpad 8 key + /// The Numpad 8 key. /// KP8 = 0xFFB8, /// - /// The Numpad 9 key + /// The Numpad 9 key. /// KP9 = 0xFFB9, /* Auxiliary Functions */ /// - /// The function 1 key + /// The Function 1 key. /// F1 = 0xFFBE, /// - /// The function 2 key + /// The Function 2 key. /// F2 = 0xFFBF, /// - /// The function 3 key + /// The Function 3 key. /// F3 = 0xFFC0, /// - /// The function 4 key + /// The Function 4 key. /// F4 = 0xFFC1, /// - /// The function 5 key + /// The Function 5 key. /// F5 = 0xFFC2, /// - /// The function 6 key + /// The Function 6 key. /// F6 = 0xFFC3, /// - /// The function 7 key + /// The Function 7 key. /// F7 = 0xFFC4, /// - /// The function 8 key + /// The Function 8 key. /// F8 = 0xFFC5, /// - /// The function 9 key + /// The Function 9 key. /// F9 = 0xFFC6, /// - /// The function 10 key + /// The Function 10 key. /// F10 = 0xFFC7, /// - /// The function 11 key + /// The Function 11 key. /// F11 = 0xFFC8, /// - /// The function 12 key + /// The Function 12 key. /// F12 = 0xFFC9, /// - /// The function 13 key + /// The Function 13 key. /// F13 = 0xFFCA, /// - /// The function 14 key + /// The Function 14 key. /// F14 = 0xFFCB, /// - /// The function 15 key + /// The Function 15 key. /// F15 = 0xFFCC, /// - /// The function 16 key + /// The Function 16 key. /// F16 = 0xFFCD, /// - /// The function 17 key + /// The Function 17 key. /// F17 = 0xFFCE, /// - /// The function 18 key + /// The Function 18 key. /// F18 = 0xFFCF, /// - /// The function 19 key + /// The Function 19 key. /// F19 = 0xFFD0, /// - /// The function 20 key + /// The Function 20 key. /// F20 = 0xFFD1, /// - /// The function 21 key + /// The Function 21 key. /// F21 = 0xFFD2, /// - /// The function 22 key + /// The Function 22 key. /// F22 = 0xFFD3, /// - /// The function 23 key + /// The Function 23 key. /// F23 = 0xFFD4, /// - /// The function 24 key + /// The Function 24 key. /// F24 = 0xFFD5, /// - /// The function 25 key + /// The Function 25 key. /// F25 = 0xFFD6, /// - /// The function 26 key + /// The Function 26 key. /// F26 = 0xFFD7, /// - /// The function 27 key + /// The Function 27 key. /// F27 = 0xFFD8, /// - /// The function 28 key + /// The Function 28 key. /// F28 = 0xFFD9, /// - /// The function 29 key + /// The Function 29 key. /// F29 = 0xFFDA, /// - /// The function 30 key + /// The Function 30 key. /// F30 = 0xFFDB, /// - /// The function 31 key + /// The Function 31 key. /// F31 = 0xFFDC, /// - /// The function 32 key + /// The Function 32 key. /// F32 = 0xFFDD, /// - /// The function 33 key + /// The Function 33 key. /// F33 = 0xFFDE, /// - /// The function 34 key + /// The Function 34 key. /// F34 = 0xFFDF, /// - /// The function 35 key + /// The Function 35 key. /// F35 = 0xFFE0, /* Modifier keys */ /// - /// The left shift key + /// The Left Shift key. /// ShiftL = 0xFFE1, /// - /// The right shift key + /// The Right Shift key. /// ShiftR = 0xFFE2, /// - /// The left control key + /// The Left Control key. /// ControlL = 0xFFE3, /// - /// The right control key + /// The Right Control key. /// ControlR = 0xFFE4, /// - /// The caps lock key + /// The Caps Lock key. /// CapsLock = 0xFFE5, /// - /// The shift lock key + /// The Shift Lock key. /// ShiftLock = 0xFFE6, /// - /// The left meta key + /// The Left Meta key. /// MetaL = 0xFFE7, /// - /// The right meta key + /// The Right Meta key. /// MetaR = 0xFFE8, /// - /// The left alt key + /// The Left Alt key. /// AltL = 0xFFE9, /// - /// The right alt key + /// The Right Alt key. /// AltR = 0xFFEA, /// - /// The left super key + /// The Left Super key. /// SuperL = 0xFFEB, /// - /// The right super key + /// The Right Super key. /// SuperR = 0xFFEC, /// - /// The left hyper key + /// The Left Hyper key. /// HyperL = 0xFFED, /// - /// The right hyper key + /// The Right Hyper key. /// HyperR = 0xFFEE, /* Latin 1 */ /// - /// The space key + /// The Space key. /// Space = 0x020, /// - /// The exclamation key + /// The Exclamation key. /// Exclam = 0x021, /// - /// The quotedbl key + /// The Quotedbl key. /// Quotedbl = 0x022, /// - /// The number sign key + /// The Number Sign key. /// NumberSign = 0x023, /// - /// The dollar key + /// The Dollar key. /// Dollar = 0x024, /// - /// The percent key + /// The Percent key. /// Percent = 0x025, /// - /// The ampersand key + /// The Ampersand key. /// Ampersand = 0x026, /// - /// The apostrophe key + /// The Apostrophe key. /// Apostrophe = 0x027, /// - /// The parenleft key + /// The Parenleft key. /// Parenleft = 0x028, /// - /// The parenright key + /// The Parenright key. /// Parenright = 0x029, /// - /// The asterisk key + /// The Asterisk key. /// Asterisk = 0x02a, /// - /// The plus key + /// The Plus key. /// Plus = 0x02b, /// - /// The comma key + /// The Comma key. /// Comma = 0x02c, /// - /// The minus key + /// The Minus key. /// Minus = 0x02d, /// - /// The period key + /// The Period key. /// Period = 0x02e, /// - /// The slash key + /// The Slash key. /// Slash = 0x02f, /// - /// The 0 key + /// The 0 key. /// Keypad0 = 0x030, /// - /// The 1 key + /// The 1 key. /// Keypad1 = 0x031, /// - /// The 2 key + /// The 2 key. /// Keypad2 = 0x032, /// - /// The 3 key + /// The 3 key. /// Keypad3 = 0x033, /// - /// The 4 key + /// The 4 key. /// Keypad4 = 0x034, /// - /// The 5 key + /// The 5 key. /// Keypad5 = 0x035, /// - /// The 6 key + /// The 6 key. /// Keypad6 = 0x036, /// - /// The 7 key + /// The 7 key. /// Keypad7 = 0x037, /// - /// The 8 key + /// The 8 key. /// Keypad8 = 0x038, /// - /// The 9 key + /// The 9 key. /// Keypad9 = 0x039, /// - /// The colon key + /// The Colon key. /// Colon = 0x03a, /// - /// The semicolon key + /// The Semicolon key. /// Semicolon = 0x03b, /// - /// The less key + /// The Less key. /// Less = 0x03c, /// - /// The equal key + /// The Equal key. /// Equal = 0x03d, /// - /// The greater key + /// The Greater key. /// Greater = 0x03e, /// - /// The question key + /// The Question key. /// Question = 0x03f, /// - /// The at key + /// The At key. /// At = 0x040, /// - /// The A key + /// The A key. /// KeypadA = 0x041, /// - /// The B key + /// The B key. /// KeypadB = 0x042, /// - /// The C key + /// The C key. /// KeypadC = 0x043, /// - /// The D key + /// The D key. /// KeypadD = 0x044, /// - /// The E key + /// The E key. /// KeypadE = 0x045, /// - /// The F key + /// The F key. /// KeypadF = 0x046, /// - /// The G key + /// The G key. /// KeypadG = 0x047, /// - /// The H key + /// The H key. /// KeypadH = 0x048, /// - /// The I key + /// The I key. /// KeypadI = 0x049, /// - /// The J key + /// The J key. /// KeypadJ = 0x04a, /// - /// The K key + /// The K key. /// KeypadK = 0x04b, /// - /// The L key + /// The L key. /// KeypadL = 0x04c, /// - /// The M key + /// The M key. /// KeypadM = 0x04d, /// - /// The N key + /// The N key. /// KeypadN = 0x04e, /// - /// The O key + /// The O key. /// KeypadO = 0x04f, /// - /// The P key + /// The P key. /// KeypadP = 0x050, /// - /// The Q key + /// The Q key. /// KeypadQ = 0x051, /// - /// The R key + /// The R key. /// KeypadR = 0x052, /// - /// The S key + /// The S key. /// KeypadS = 0x053, /// - /// The T key + /// The T key. /// KeypadT = 0x054, /// - /// The U key + /// The U key. /// KeypadU = 0x055, /// - /// The V key + /// The V key. /// KeypadV = 0x056, /// - /// The W key + /// The W key. /// KeypadW = 0x057, /// - /// The X key + /// The X key. /// KeypadX = 0x058, /// - /// The Y key + /// The Y key. /// KeypadY = 0x059, /// - /// The Z key + /// The Z key. /// KeypadZ = 0x05a, /// - /// The left bracket key + /// The Left Bracket key. /// BracketLeft = 0x05b, /// - /// The backslash key + /// The Backslash key. /// Backslash = 0x05c, /// - /// The right bracket key + /// The Right Bracket key. /// BracketRight = 0x05d, /// - /// The circumflex key + /// The Circumflex key. /// AsciiCircum = 0x05e, /// - /// The underscore key + /// The Underscore key. /// Underscore = 0x05f, /// - /// The grave key + /// The Grave key. /// Grave = 0x060, /// - /// The a key + /// The a key. /// Keypada = 0x061, /// - /// The b key + /// The b key. /// Keypadb = 0x062, /// - /// The c key + /// The c key. /// Keypadc = 0x063, /// - /// The d key + /// The d key. /// Keypadd = 0x064, /// - /// The e key + /// The e key. /// Keypade = 0x065, /// - /// The f key + /// The f key. /// Keypadf = 0x066, /// - /// The g key + /// The g key. /// Keypadg = 0x067, /// - /// The h key + /// The h key. /// Keypadh = 0x068, /// - /// The i key + /// The i key. /// Keypadi = 0x069, /// - /// The j key + /// The j key. /// Keypadj = 0x06a, /// - /// The k key + /// The k key. /// Keypadk = 0x06b, /// - /// The l key + /// The l key. /// Keypadl = 0x06c, /// - /// The m key + /// The m key. /// Keypadm = 0x06d, /// - /// The n key + /// The n key. /// Keypadn = 0x06e, /// - /// The o key + /// The o key. /// Keypado = 0x06f, /// - /// The p key + /// The p key. /// Keypadp = 0x070, /// - /// The q key + /// The q key. /// Keypadq = 0x071, /// - /// The r key + /// The r key. /// Keypadr = 0x072, /// - /// The s key + /// The s key. /// Keypads = 0x073, /// - /// The t key + /// The t key. /// Keypadt = 0x074, /// - /// The u key + /// The u key. /// Keypadu = 0x075, /// - /// The v key + /// The v key. /// Keypadv = 0x076, /// - /// The w key + /// The w key. /// Keypadw = 0x077, /// - /// The x key + /// The x key. /// Keypadx = 0x078, /// - /// The y key + /// The y key. /// Keypady = 0x079, /// - /// The z key + /// The z key. /// Keypadz = 0x07a, /// - /// The left brace key + /// The Left Brace key. /// BraceLeft = 0x07b, /// - /// The bar key + /// The Bar key. /// Bar = 0x07c, /// - /// The right brace key + /// The Right Brace key. /// BraceRight = 0x07d, /// - /// The tilde key + /// The Tilde key. /// AsciiTilde = 0x07e, }; /// - /// Enumeration of the key masks. - /// The key masks indicate which modifier keys is pressed down during the keyboard hit.The special MASK_RELEASED indicates the key release event. + /// Enumeration for the key masks. + /// The key masks indicate which modifier keys are pressed down during the keyboard hit. The special MASK_RELEASED indicates the key release event. /// /// 4 public enum KeyMask { /// - /// Key press event without modifier key + /// Key press event without the modifier key. /// Pressed = 0, /// - /// The Shift key is pressed down + /// The Shift key is pressed down. /// Shift = (1 << 0), /// - /// The CapsLock key is pressed down + /// The CapsLock key is pressed down. /// CapsLock = (1 << 1), /// - /// The Control key is pressed down + /// The Control key is pressed down. /// Control = (1 << 2), /// - /// The Alt key is pressed down + /// The Alt key is pressed down. /// Alt = (1 << 3), /// - /// The Meta key is pressed down + /// The Meta key is pressed down. /// Meta = (1 << 4), /// - /// The Win (between Control and Alt) is pressed down + /// The Win key (between Control and Alt) is pressed down. /// Win = (1 << 5), /// - /// The Hyper key is pressed down + /// The Hyper key is pressed down. /// Hyper = (1 << 6), /// - /// The NumLock key is pressed down + /// The NumLock key is pressed down. /// NumLock = (1 << 7), /// - /// Key release event + /// Key release event. /// Released = (1 << 15), } /// - /// This class contains api's related to IME(Input method editor) + /// This class contains the API's related to the IME (Input method editor). /// /// 4 public static class InputMethodEditor @@ -1022,7 +1022,7 @@ namespace Tizen.Uix.InputMethod }; /// - /// Structure representing ContextId + /// Structure representing the ContextId. /// /// 4 public struct ContextId : IEquatable @@ -1039,7 +1039,7 @@ namespace Tizen.Uix.InputMethod } /// - /// compare whether ContextId are equal + /// Compares whether the ContextIds are equal. /// /// 4 public bool Equals(ContextId other) @@ -1049,61 +1049,61 @@ namespace Tizen.Uix.InputMethod } /// - /// rectangle representing the position and size of UI Control + /// Rectangle representing the position and size of the UI control. /// /// 4 public struct Rect { /// - /// The x position in screen + /// The X position in the screen. /// /// 4 public int x; /// - /// The y position in screen + /// The Y position in the screen. /// /// 4 public int y; /// - /// The window width + /// The window width. /// /// 4 public int w; /// - /// The window height + /// The window height. /// /// 4 public int h; } /// - /// An Action with 1 out parameter + /// An action with 1 out parameter. /// - /// Generic Type - /// The out parameter + /// Generic Type. + /// The out parameter. /// 4 public delegate void OutAction(out T a); /// - /// An Action with an array out parameter + /// An action with an array out parameter. /// - /// Generic Type - /// The out parameter 1 + /// Generic Type. + /// The out parameter 1. /// 4 public delegate void OutArrayAction(out T[] a); /// - /// An Action with 3 Input Parameter returning a bool + /// An action with 3 input parameters returning a bool. /// - /// Generic Type for Parameter 1 - /// Generic Type for Parameter 2 - /// Generic Type for Parameter 3 - /// The Input Parameter 1 - /// The Input Parameter 2 - /// The Input Parameter 3 + /// Generic type for parameter 1. + /// Generic type for parameter 2. + /// Generic type for parameter 3. + /// The input parameter 1. + /// The input parameter 2. + /// The input parameter 3. /// /// 4 public delegate bool BoolAction(T a, T1 b, T2 c); @@ -1284,7 +1284,7 @@ namespace Tizen.Uix.InputMethod /// /// Called to set the preferred language to the input panel. - /// It will be only called when the client application changes the edit field's language attribute after the input panel is shown. + /// It will only be called when the client application changes the edit field's language attribute after the input panel is shown. /// /// 4 public static event EventHandler LanguageSet @@ -1357,7 +1357,7 @@ namespace Tizen.Uix.InputMethod /// /// Called when an associated text input UI control requests the input panel to set its layout. - /// It will be only called when the client application changes the edit field's layout attribute after the input panel is shown. + /// It will only be called when the client application changes the edit field's layout attribute after the input panel is shown. /// /// 4 public static event EventHandler LayoutSet @@ -1393,7 +1393,7 @@ namespace Tizen.Uix.InputMethod /// /// Called when an associated text input UI control requests the input panel to set the Return key label. - /// The input panel can show text or image on the Return button according to the Return key action. + /// The input panel can show the text or an image on the Return button, according to the Return key action. /// /// 4 public static event EventHandler ReturnKeySet @@ -1463,7 +1463,7 @@ namespace Tizen.Uix.InputMethod } /// - /// Called when the system display Language is changed. + /// Called when the system display language is changed. /// /// 4 public static event EventHandler DisplayLanguageChanged @@ -1533,7 +1533,7 @@ namespace Tizen.Uix.InputMethod } /// - /// Called when Accessibility in Settings application is on or off. + /// Called when Accessibility in settings application is on or off. /// /// 4 public static event EventHandler AccessibilityStateChanged @@ -1568,7 +1568,7 @@ namespace Tizen.Uix.InputMethod } /// - /// Sets the languageRequested Action + /// Sets the languageRequested action. /// /// /// Called when an associated text input UI control requests the language from the input panel, requesting for language code. @@ -1593,11 +1593,11 @@ namespace Tizen.Uix.InputMethod } /// - /// Sets the processKey Action - /// If the key event is from the external device, DeviceInfo will have its name, class and subclass information. + /// Sets the processKey action. + /// If the key event is from the external device, DeviceInfo will have its name, class, and subclass information. /// /// - /// The Action is alled when the key event is received from the external devices or SendKey function. + /// The action is called when the key event is received from the external devices or the SendKey function. /// This Event processes the key event before an associated text input UI control does. /// /// 4 @@ -1616,7 +1616,7 @@ namespace Tizen.Uix.InputMethod } /// - /// Sets the imDataRequested Action + /// Sets the imDataRequested action. /// /// /// Called when an associated text input UI control requests the application specific data from the input panel, requesting for data array and it's length. @@ -1641,10 +1641,10 @@ namespace Tizen.Uix.InputMethod } /// - /// Sets the GeometryRequested Action + /// Sets the GeometryRequested action. /// /// - /// Called when an associated text input UI control requests the position and size from the input panel, requesting for x,y,w,h values. + /// Called when an associated text input UI control requests the position and size from the input panel, requesting for x, y, w, h values. /// /// 4 public static void SetGeometryRequestedCallback(OutAction geometryRequested) @@ -1667,8 +1667,8 @@ namespace Tizen.Uix.InputMethod } /// - /// Runs the main loop of IME application. - /// This function starts to run IME application's main loop. + /// Runs the main loop of the IME application. + /// This function starts to run the IME application's main loop. /// /// /// http://tizen.org/privilege/ime @@ -1676,20 +1676,20 @@ namespace Tizen.Uix.InputMethod /// /// This API is a blocking call, as it starts the main loop of the application. /// - /// This is called to initialize IME application before the main loop starts up - /// This is called when IME application is terminated + /// This is called to initialize the IME application before the main loop starts up. + /// This is called when the IME application is terminated. /// - /// This is called when IME application is shown - /// It provides the Context Information and the Context Id + /// This is called when the IME application is shown. + /// It provides the context information and the context ID. /// /// - /// This is called when IME application is hidden - /// It provides the Context Id + /// This is called when the IME application is hidden. + /// It provides the context ID. /// /// /// This can occur due to the following reasons: - /// 1) The application does not have the privilege to call this function - /// 2) Operation failed + /// 1) The application does not have the privilege to call this function. + /// 2) Operation failed. /// /// 4 public static void Run(Action create, Action terminate, Action show, Action hide) @@ -1717,19 +1717,19 @@ namespace Tizen.Uix.InputMethod /// Sends a key event to the associated text input UI control. /// /// - /// This function sends key down or up event with key mask to the client application. If forwardKey is true, this key event goes to the edit filed directly. + /// This function sends a key down or up event with the key mask to the client application. If forwardKey is true, this key event goes to the edit filed directly. /// And if forwardKey is false, the ProcessKey event receives the key event before the edit field. /// /// /// http://tizen.org/privilege/ime /// - /// The key code to be sent - /// The modifier key mask - /// The flag to send the key event directly to the edit field + /// The key code to be sent. + /// The modifier key mask. + /// The flag to send the key event directly to the edit field. /// /// This can occur due to the following reasons: - /// 1) The application does not have the privilege to call this function - /// 2) IME main loop isn't started yet + /// 1) The application does not have the privilege to call this function. + /// 2) The IME main loop isn't started yet. /// /// 4 public static void SendKeyEvent(KeyCode keyCode, KeyMask keyMask, bool forwardKey = false) @@ -1748,11 +1748,11 @@ namespace Tizen.Uix.InputMethod /// /// http://tizen.org/privilege/ime /// - /// The string to be committed + /// The string to be committed. /// /// This can occur due to the following reasons: - /// 1) The application does not have the privilege to call this function - /// 2) IME main loop isn't started yet + /// 1) The application does not have the privilege to call this function. + /// 2) The IME main loop isn't started yet. /// /// 4 public static void CommitString(string str) @@ -1766,15 +1766,15 @@ namespace Tizen.Uix.InputMethod } /// - /// Requests to show preedit string. + /// Requests to show the pre-edit string. /// /// /// http://tizen.org/privilege/ime /// /// /// This can occur due to the following reasons: - /// 1) The application does not have the privilege to call this function - /// 2) IME main loop isn't started yet + /// 1) The application does not have the privilege to call this function. + /// 2) The IME main loop isn't started yet. /// /// 4 public static void ShowPreEditString() @@ -1788,15 +1788,15 @@ namespace Tizen.Uix.InputMethod } /// - /// Requests to hide preedit string. + /// Requests to hide the pre-edit string. /// /// /// http://tizen.org/privilege/ime /// /// /// This can occur due to the following reasons: - /// 1) The application does not have the privilege to call this function - /// 2) IME main loop isn't started yet + /// 1) The application does not have the privilege to call this function. + /// 2) The IME main loop isn't started yet. /// /// 4 public static void HidePreEditString() @@ -1810,21 +1810,21 @@ namespace Tizen.Uix.InputMethod } /// - /// Updates a new preedit string. + /// Updates a new pre-edit string. /// /// /// http://tizen.org/privilege/ime /// - /// The string to be updated in preedit + /// The string to be updated in pre-edit. /// - /// The list which has ime_preedit_attribute lists, strings can be composed of multiple string attributes: underline, highlight color and reversal color. - /// The attrs list can be empty if no attributes to set + /// The list which has ime_preedit_attribute lists, strings can be composed of multiple string attributes: underline, highlight color, and reversal color. + /// The attrs list can be empty if no attributes to set. /// /// /// This can occur due to the following reasons: - /// 1) The application does not have the privilege to call this function - /// 2) IME main loop isn't started yet - /// 3) Invalid Parameter + /// 1) The application does not have the privilege to call this function. + /// 2) The IME main loop isn't started yet. + /// 3) Invalid parameter. /// /// 4 public static void UpdatePreEditString(string str, IEnumerable attrs) @@ -1860,15 +1860,15 @@ namespace Tizen.Uix.InputMethod /// /// http://tizen.org/privilege/ime /// - /// The maximum length of string to be retrieved before the cursor, -1 means unlimited - /// The maximum length of string to be retrieved after the cursor, -1 means unlimited + /// The maximum length of the string to be retrieved before the cursor, -1 means unlimited. + /// The maximum length of the string to be retrieved after the cursor, -1 means unlimited. /// /// This can occur due to the following reasons: - /// 1) The application does not have the privilege to call this function - /// 2) IME main loop isn't started yet + /// 1) The application does not have the privilege to call this function. + /// 2) The IME main loop isn't started yet. /// /// - /// The requested surrounding text can be received using the SurroundingTextUpdated Event, only if it is set. + /// The requested surrounding text can be received using the SurroundingTextUpdated event, only if it is set. /// /// 4 public static void RequestSurroundingText(int maxLenBefore, int maxLenAfter) @@ -1882,18 +1882,18 @@ namespace Tizen.Uix.InputMethod } /// - /// Requests to delete surrounding text. + /// Requests to delete the surrounding text. /// /// /// http://tizen.org/privilege/ime /// - /// The offset value from the cursor position - /// The length of the text to delete + /// The offset value from the cursor position. + /// The length of the text to delete. /// /// This can occur due to the following reasons: - /// 1) The application does not have the privilege to call this function - /// 2) IME main loop isn't started yet - /// 3) Invalid Parameter + /// 1) The application does not have the privilege to call this function. + /// 2) The IME main loop isn't started yet. + /// 3) Invalid parameter. /// /// 4 public static void DeleteSurroundingText(int offset, int len) @@ -1912,16 +1912,16 @@ namespace Tizen.Uix.InputMethod /// /// http://tizen.org/privilege/ime /// - /// The maximum length of string to be retrieved before the cursor, -1 means unlimited - /// The maximum length of string to be retrieved after the cursor, -1 means unlimited - /// The surrounding text - /// The cursor position + /// The maximum length of the string to be retrieved before the cursor, -1 means unlimited. + /// The maximum length of the string to be retrieved after the cursor, -1 means unlimited. + /// The surrounding text. + /// The cursor position. /// /// This can occur due to the following reasons: - /// 1) The application does not have the privilege to call this function - /// 2) IME main loop isn't started yet - /// 3) Invalid Parameter - /// 4) Failed to obtain text due to out of memory + /// 1) The application does not have the privilege to call this function. + /// 2) The IME main loop isn't started yet. + /// 3) Invalid parameter. + /// 4) Failed to obtain text due to out of memory. /// /// 4 public static void GetSurroundingText(int maxLenBefore, int maxLenAfter, out string text, out int cursorPosition) @@ -1937,18 +1937,18 @@ namespace Tizen.Uix.InputMethod } /// - /// Requests to set selection. + /// Requests to set the selection. /// /// /// http://tizen.org/privilege/ime /// - /// The start cursor position in text (in characters not bytes) - /// The end cursor position in text (in characters not bytes) + /// The start cursor position in text (in characters not bytes). + /// The end cursor position in text (in characters not bytes). /// /// This can occur due to the following reasons: - /// 1) The application does not have the privilege to call this function - /// 2) IME main loop isn't started yet - /// 3) Invalid Parameter + /// 1) The application does not have the privilege to call this function. + /// 2) The IME main loop isn't started yet. + /// 3) Invalid parameter. /// /// 4 public static void SetSelection(int start, int end) @@ -1967,12 +1967,12 @@ namespace Tizen.Uix.InputMethod /// /// http://tizen.org/privilege/ime /// - /// The input panel main window object on success, otherwise null + /// The input panel main window object on success, otherwise null. /// /// This can occur due to the following reasons: - /// 1) The application does not have the privilege to call this function - /// 2) IME main loop isn't started yet - /// 3) Operation Failed + /// 1) The application does not have the privilege to call this function. + /// 2) The IME main loop isn't started yet. + /// 3) Operation failed. /// /// 4 public static EditorWindow GetMainWindow() @@ -1989,15 +1989,15 @@ namespace Tizen.Uix.InputMethod } /// - /// This API requests the InputMethodEditor to initialize + /// This API requests the InputMethodEditor to initialize. /// /// /// http://tizen.org/privilege/ime /// /// /// This can occur due to the following reasons: - /// 1) The application does not have the privilege to call this function - /// 2) Operation Failed + /// 1) The application does not have the privilege to call this function. + /// 2) Operation failed. /// /// 4 public static void Create() @@ -2020,15 +2020,15 @@ namespace Tizen.Uix.InputMethod } /// - /// This API requests the InputMethodEditor to finalize + /// This API requests the InputMethodEditor to finalize. /// /// /// http://tizen.org/privilege/ime /// /// /// This can occur due to the following reasons: - /// 1) The application does not have the privilege to call this function - /// 2) Operation Failed + /// 1) The application does not have the privilege to call this function. + /// 2) Operation failed. /// /// 4 public static void Destroy() diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/LanguageSetSetEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/LanguageSetSetEventArgs.cs index aa78887..33d6083 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/LanguageSetSetEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/LanguageSetSetEventArgs.cs @@ -17,7 +17,7 @@ namespace Tizen.Uix.InputMethod { /// - /// This Class contains data related to LanguageSet Event + /// This class contains the data related to the LanguageSet event. /// /// 4 public class LanguageSetEventArgs @@ -28,7 +28,7 @@ namespace Tizen.Uix.InputMethod } /// - /// The preferred language that the client application wants + /// The preferred language that the client application wants. /// /// 4 public InputPanelLanguage Language diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/LayoutSetEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/LayoutSetEventArgs.cs index 0d7ebeb..e6e3dba 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/LayoutSetEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/LayoutSetEventArgs.cs @@ -17,7 +17,7 @@ namespace Tizen.Uix.InputMethod { /// - /// This Class contains data related to LayoutSet Event + /// This class contains the data related to the LayoutSet event. /// /// 4 public class LayoutSetEventArgs @@ -28,7 +28,7 @@ namespace Tizen.Uix.InputMethod } /// - /// The input panel layout + /// The input panel layout. /// /// 4 public InputPanelLayout Layout diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/PreEditAttribute.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/PreEditAttribute.cs index c2d026f..202517f 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/PreEditAttribute.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/PreEditAttribute.cs @@ -21,28 +21,28 @@ using System.Text; namespace Tizen.Uix.InputMethod { /// - /// Enumeration for Attribute Type + /// Enumeration for the attribute types. /// /// 4 public enum AttributeType { /// - /// No attribute + /// No attribute. /// None, /// - /// A font style attribute, e.g., underline, etc. + /// A font style attribute, for example, underline, etc. /// FontStyle }; /// - /// This class represents the attributes for preedit string. + /// This class represents the attributes for the pre-edit string. /// /// 4 public class PreEditAttribute { /// - /// The start position in the string of this attribute + /// The start position in the string of this attribute. /// /// 4 public uint Start @@ -52,7 +52,7 @@ namespace Tizen.Uix.InputMethod } /// - /// The character length of this attribute, the range is [Start, Start+Length] + /// The character length of this attribute, the range is [Start, Start+Length]. /// /// 4 public uint Length @@ -62,7 +62,7 @@ namespace Tizen.Uix.InputMethod } /// - /// The type of this attribute + /// The type of this attribute. /// /// 4 public AttributeType Type @@ -72,7 +72,7 @@ namespace Tizen.Uix.InputMethod } /// - /// The value of this attribute + /// The value of this attribute. /// /// 4 public uint Value diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/ReturnKeyStateSetEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/ReturnKeyStateSetEventArgs.cs index 2424f76..626896c 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/ReturnKeyStateSetEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/ReturnKeyStateSetEventArgs.cs @@ -17,7 +17,7 @@ namespace Tizen.Uix.InputMethod { /// - /// This Class contains data related to ReturnKeyStateSet Event + /// This class contains the data related to the ReturnKeyStateSet event. /// /// 4 public class ReturnKeyStateSetEventArgs @@ -28,7 +28,7 @@ namespace Tizen.Uix.InputMethod } /// - /// The bool state to disable Return key. The Return key is enabled by default + /// The bool state to disable the Return key. The Return key is enabled by default. /// /// 4 public bool State diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/ReturnKeyTypeSetEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/ReturnKeyTypeSetEventArgs.cs index 7060d26..7e6ab3b 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/ReturnKeyTypeSetEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/ReturnKeyTypeSetEventArgs.cs @@ -17,7 +17,7 @@ namespace Tizen.Uix.InputMethod { /// - /// This Class contains data related to ReturnKeySet Event + /// This class contains the data related to the ReturnKeySet event. /// /// 4 public class ReturnKeySetEventArgs @@ -28,7 +28,7 @@ namespace Tizen.Uix.InputMethod } /// - /// The type of Return key on the input panel + /// The type of the Return key on the input panel. /// /// 4 public InputPanelReturnKey Type diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/RotationChangedEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/RotationChangedEventArgs.cs index 6b316f3..b9a966d 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/RotationChangedEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/RotationChangedEventArgs.cs @@ -17,7 +17,7 @@ namespace Tizen.Uix.InputMethod { /// - /// This Class contains data related to RotationChanged Event + /// This class contains the data related to the RotationChanged event. /// /// 4 public class RotationChangedEventArgs @@ -28,7 +28,7 @@ namespace Tizen.Uix.InputMethod } /// - /// The rotation degree + /// The rotation degree. /// /// 4 public int Degree diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/SurroundingTextUpdatedArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/SurroundingTextUpdatedArgs.cs index 6999069..6ede400 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/SurroundingTextUpdatedArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/SurroundingTextUpdatedArgs.cs @@ -17,7 +17,7 @@ namespace Tizen.Uix.InputMethod { /// - /// This Class contains data related to SurroundingTextUpdated Event + /// This class contains the data related to the SurroundingTextUpdated event. /// /// 4 public class SurroundingTextUpdatedEventArgs @@ -30,7 +30,7 @@ namespace Tizen.Uix.InputMethod } /// - /// The input context identification value of an associated text input UI control + /// The input context identification value of an associated text input UI control. /// /// 4 public int ContextId @@ -40,7 +40,7 @@ namespace Tizen.Uix.InputMethod } /// - /// The cursor position + /// The cursor position. /// /// 4 public int CursorPosition @@ -50,7 +50,7 @@ namespace Tizen.Uix.InputMethod } /// - /// The string requested + /// The string requested. /// /// 4 public string Text diff --git a/src/Tizen.Uix.SttEngine/Interop/Interop.Libraries.cs b/src/Tizen.Uix.SttEngine/Interop/Interop.Libraries.cs index 83566e5..3964bae 100755 --- a/src/Tizen.Uix.SttEngine/Interop/Interop.Libraries.cs +++ b/src/Tizen.Uix.SttEngine/Interop/Interop.Libraries.cs @@ -16,12 +16,12 @@ /// -/// Partial Interop Class +/// The Partial Interop class. /// internal static partial class Interop { /// - /// Partial Libraries Class + /// The Partial Libraries class. /// internal static partial class Libraries { diff --git a/src/Tizen.Uix.SttEngine/Interop/Interop.SttEngine.cs b/src/Tizen.Uix.SttEngine/Interop/Interop.SttEngine.cs index 902d487..6aea927 100755 --- a/src/Tizen.Uix.SttEngine/Interop/Interop.SttEngine.cs +++ b/src/Tizen.Uix.SttEngine/Interop/Interop.SttEngine.cs @@ -21,12 +21,12 @@ using Tizen.Uix.SttEngine; using static Tizen.Uix.SttEngine.Engine; /// -/// Partial Interop Class +/// The Partial Interop class. /// internal static partial class Interop { /// - /// SttEngine Interop Class + /// The SttEngine Interop class. /// internal static class SttEngine { diff --git a/src/Tizen.Uix.SttEngine/Tizen.Uix.SttEngine/SttEngine.cs b/src/Tizen.Uix.SttEngine/Tizen.Uix.SttEngine/SttEngine.cs index 7b4a684..ed3580b 100755 --- a/src/Tizen.Uix.SttEngine/Tizen.Uix.SttEngine/SttEngine.cs +++ b/src/Tizen.Uix.SttEngine/Tizen.Uix.SttEngine/SttEngine.cs @@ -21,172 +21,172 @@ using static Interop.SttEngine; namespace Tizen.Uix.SttEngine { /// - /// Enumeration for audio type. + /// Enumeration for the audio types. /// /// 4 public enum AudioType { /// - /// Signed 16bit audio type, Little endian + /// Signed 16-bit audio type, little endian. /// PcmS16Le = 0, /// - /// Unsigned 8bit audio type + /// Unsigned 8-bit audio type. /// PcmU8 }; /// - /// Enumeration for result. + /// Enumeration for the results. /// /// 4 public enum ResultEvent { /// - /// Event when either the full matched or the final result is delivered + /// Event when either the full matched or the final result is delivered. /// FinalResult = 0, /// - /// Event when the partial matched result is delivered + /// Event when the partial matched result is delivered. /// PartialResult, /// - /// Event when the recognition has failed + /// Event when the recognition has failed. /// Error }; /// - /// Enumeration for result time. + /// Enumeration for the result time. /// /// 4 public enum TimeEvent { /// - /// Event when the token is beginning type + /// Event when the token is beginning type. /// Beginning = 0, /// - /// Event when the token is middle type + /// Event when the token is middle type. /// Middle = 1, /// - /// Event when the token is end type + /// Event when the token is end type. /// End = 2 }; /// - /// Enumeration for speech status. + /// Enumeration for the speech status. /// /// 4 public enum SpeechStatus { /// - /// Beginning point of speech is detected + /// Beginning point of the speech is detected. /// BeginningPointDetected = 0, /// - /// End point of speech is detected + /// End point of the speech is detected. /// EndPointDetected }; /// - /// Enumeration representing the result message + /// Enumeration for representing the result message. /// /// 4 public enum ResultMessage { /// - /// No Error + /// No error. /// None, /// - /// Recognition failed because the speech started too soon. + /// Recognition failed because the speech started too soon. /// TooSoon, /// - /// Recognition failed because the speech is too short. + /// Recognition failed because the speech is too short. /// TooShort, /// - /// Recognition failed because the speech is too long. + /// Recognition failed because the speech is too long. /// TooLong, /// - /// Recognition failed because the speech is too quiet to listen. + /// Recognition failed because the speech is too quiet to listen. /// TooQuiet, /// - /// Recognition failed because the speech is too loud to listen. + /// Recognition failed because the speech is too loud to listen. /// TooLoud, /// - /// Recognition failed because the speech is too fast to listen. + /// Recognition failed because the speech is too fast to listen. /// TooFast }; /// - /// Enum for Error values that can occur + /// Enumeration for the error values that can occur. /// /// 4 public enum Error { /// - /// Successful, No error + /// Successful, no error. /// None = ErrorCode.None, /// - /// Out of Memory + /// Out of memory. /// OutOfMemory = ErrorCode.OutOfMemory, /// - /// I/O error + /// I/O error. /// IoError = ErrorCode.IoError, /// - /// Invalid parameter + /// Invalid parameter. /// InvalidParameter = ErrorCode.InvalidParameter, /// - /// Network down(Out of network) + /// Network down (Out of network). /// NetworkDown = ErrorCode.NetworkDown, /// - /// Invalid state + /// Invalid state. /// InvalidState = ErrorCode.InvalidState, /// - /// Invalid language + /// Invalid language. /// InvalidLanguage = ErrorCode.InvalidLanguage, /// - /// Operation failed + /// Operation failed. /// OperationFailed = ErrorCode.OperationFailed, /// - /// Not supported feature of current engine + /// Not supported feature of the current engine. /// NotSupportedFeature = ErrorCode.NotSupportedFeature, /// - /// NOT supported + /// Not supported. /// NotSupported = ErrorCode.NotSupported, /// - /// Permission denied + /// Permission denied. /// PermissionDenied = ErrorCode.PermissionDenied, /// - /// Recording timed out + /// Recording timed out. /// RecordingTimedOut = ErrorCode.RecordingTimedOut }; /// - /// This Class represents the Stt Engine which has to be inherited to make the engine. + /// This class represents the STT Engine, which has to be inherited to make the engine. /// /// 4 public abstract class Engine @@ -200,65 +200,65 @@ namespace Tizen.Uix.SttEngine private IntPtr _structIntPtrHandle; /// - /// An Action with 2 Input Parameter returning a Error + /// An action with 2 input parameters returning an error. /// - /// Generic Type for Parameter 1 - /// The Input Parameter 1 - /// The Input Parameter 2 - /// Error Value + /// Generic type for parameter 1. + /// The input parameter 1. + /// The input parameter 2. + /// Error value. /// 4 public delegate Error Action(T a, T b); /// - /// An Action with 2 Out Parameter returning a Error + /// An action with 2 out parameters returning an error. /// - /// Generic Type for Parameter 1 - /// The Input Parameter 1 - /// The Input Parameter 2 - /// Error Value + /// Generic type for parameter 1. + /// The input parameter 1. + /// The input parameter 2. + /// Error value. /// 4 public delegate Error OutAction(T a, out T b); /// - /// Called when Stt engine provides the time stamp of result to the engine service user. + /// Called when the STT engine provides the time stamp of result to the engine service user. /// This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function. /// - /// The result index - /// The token event - /// The result text - /// The time started speaking the result text - /// The time finished speaking the result text - /// The User data - /// true to continue with the next iteration of the loop, false to break out of the loop + /// The result index. + /// The token event. + /// The result text. + /// The time started speaking the result text. + /// The time finished speaking the result text. + /// The user data. + /// true to continue with the next iteration of the loop, false to break out of the loop. /// SendResult() should be called. /// 4 public delegate bool ResultTime(int index, TimeEvent resultEvent, string text, long startTime, long endTime, IntPtr userData); /// - /// Called when Stt engine informs the engine service user about whole supported language list. + /// Called when the STT engine informs the engine service user about the whole supported language list. /// This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function. /// /// The language is specified as an ISO 3166 alpha-2 two letter country-code - /// followed by ISO 639-1 for the two-letter language code - /// for example, "ko_KR" for Korean, "en_US" for American English - /// The User data - /// true to continue with the next iteration of the loop, false to break out of the loop - /// ForEachSupportedLanguages() should be called + /// followed by an ISO 639-1 for the two-letter language code. + /// For example, "ko_KR" for Korean, "en_US" for American English. + /// The user data. + /// true to continue with the next iteration of the loop, false to break out of the loop. + /// ForEachSupportedLanguages() should be called. /// 4 public delegate bool SupportedLanguages(string language, IntPtr userData); /// - /// Called when the engine service user requests the basic information of Stt engine. + /// Called when the engine service user requests the basic information of the STT engine. /// /// - /// In order to upload the engine at Tizen Appstore, both a service app and a ui app are necessary. Therefore, engineSetting must be transferred to the engine service user. + /// In order to upload the engine at Tizen Appstore, both a service application and a UI application are necessary. Therefore, engineSetting must be transferred to the engine service user. /// - /// UUID of engine - /// Name of engine - /// The engine setting application(ui app)'s app ID - /// A variable for checking whether the network is used or not + /// UUID of the engine. + /// Name of the engine. + /// The engine setting application (UI app)'s ID. + /// A variable for checking whether the network is used or not. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. OperationFailed /// 3. InvalidParameter @@ -267,11 +267,11 @@ namespace Tizen.Uix.SttEngine public abstract Error GetInformation(out string engineUuid, out string engineName, out string engineSetting, out bool useNetwork); /// - /// Called when the engine service user initializes Stt engine. - /// This callback function is called by the engine service user to request for Stt engine to be started. + /// Called when the engine service user initializes the STT engine. + /// This callback function is called by the engine service user to request for the STT engine to be started. /// /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidParameter /// 3. InvalidState @@ -281,11 +281,11 @@ namespace Tizen.Uix.SttEngine public abstract Error Initialize(); /// - /// Called when the engine service user deinitializes Stt engine. - /// This callback function is called by the engine service user to request for Stt engine to be deinitialized. + /// Called when the engine service user deinitializes the STT engine. + /// This callback function is called by the engine service user to request for the STT engine to be deinitialized. /// /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// @@ -296,31 +296,31 @@ namespace Tizen.Uix.SttEngine /// Called when the engine service user gets the whole supported language list. /// /// - /// In this function, the engine service user's callback function 'SupportedLanguages' is invoked repeatedly for getting all supported languages + /// In this function, the engine service user's callback function 'SupportedLanguages' is invoked repeatedly for getting all the supported languages /// and user_data must be transferred to 'SupportedLanguages'. If 'SupportedLanguages' returns false, it should be stopped to call 'SupportedLanguages'. /// - /// The callback function - /// The user data which must be passed to the callback delegate 'SupportedLanguages' + /// The callback function, + /// The user data, which must be passed to the callback delegate 'SupportedLanguages'. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// 3. InvalidParameter /// /// - /// This callback function invokes SupportedLanguages repeatedly for getting supported languages. + /// This callback function invokes SupportedLanguages repeatedly for getting the supported languages. /// /// 4 public abstract Error ForEachSupportedLanguages(SupportedLanguages callback, IntPtr userData); /// - /// Called when the engine service user checks whether the corresponding language is valid or not in Stt engine. + /// Called when the engine service user checks whether the corresponding language is valid or not in the STT 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 - /// A variable for checking whether the corresponding language is valid or not. true to be valid, false to be invalid + /// The language is specified as an ISO 3166 alpha-2 two letter country-code followed by an ISO 639-1 for the two-letter language code. + /// For example, "ko_KR" for Korean, "en_US" for American English. + /// A variable for checking whether the corresponding language is valid or not. true to be valid, false to be invalid. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidParameter /// @@ -328,20 +328,20 @@ namespace Tizen.Uix.SttEngine public abstract Error IsValidLanguage(string language, out bool isValid); /// - /// Called when the engine service user checks whether Stt engine supports silence detection. + /// Called when the engine service user checks whether the STT engine supports silence detection. /// - /// true to support silence detection, false not to support silence detection + /// true to support silence detection, false not to support silence detection. /// 4 public abstract bool SupportSilenceDetection(); /// - /// Called when the engine service user checks whether Stt engine supports the corresponding recognition type. + /// Called when the engine service user checks whether the STT engine supports the corresponding recognition type. /// - /// The type for recognition, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL" - /// A variable for checking whether Stt engine supports the corresponding recognition type. - /// true to support recognition type, false not to support recognition type + /// The type for recognition, "stt.recognition.type.FREE", or "stt.recognition.type.FREE.PARTIAL". + /// A variable for checking whether the STT engine supports the corresponding recognition type. + /// true to support the recognition type, false not to support the recognition type. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidParameter /// @@ -349,14 +349,14 @@ namespace Tizen.Uix.SttEngine public abstract Error SupportRecognitionType(string type, out bool isSupported); /// - /// Called when the engine service user gets the proper recording format of Stt engine. + /// Called when the engine service user gets the proper recording format of the STT engine. /// The recording format is used for creating the recorder. /// - /// The format used by the recorder - /// The sample rate used by the recorder - /// The number of channels used by the recorder + /// The format used by the recorder. + /// The sample rate used by the recorder. + /// The number of channels used by the recorder. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// @@ -365,11 +365,11 @@ namespace Tizen.Uix.SttEngine /// /// Called when the engine service user sets the silence detection. - /// If the engine service user sets this option as 'TRUE', Stt engine will detect the silence (EPD) and send the callback event about it. + /// If the engine service user sets this option as 'TRUE', the STT engine will detect the silence (EPD) and send the callback event about it. /// - /// A variable for setting the silence detection. true to detect the silence, false not to detect the silence + /// A variable for setting the silence detection. true to detect the silence, false not to detect the silence. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// 3. NotSupportedFeature @@ -378,14 +378,14 @@ namespace Tizen.Uix.SttEngine public abstract Error SetSilenceDetection(bool isSet); /// - /// Called when the engine service user requests for Stt engine to check whether the application agreed the usage of Stt engine. - /// This callback function is called when the engine service user requests for Stt engine to check the application's agreement about using the engine. + /// Called when the engine service user requests for the STT engine to check whether the application agreed the usage of the STT engine. + /// This callback function is called when the engine service user requests for the STT engine to check the application's agreement about using the engine. /// According to the need, the engine developer can provide some user interfaces to check the agreement. /// /// The Application ID - /// A variable for checking whether the application agreed to use Stt engine or not. true to agree, false to disagree + /// A variable for checking whether the application agreed to use the STT engine or not. true to agree, false to disagree. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// 3. NotSupportedFeature @@ -394,9 +394,9 @@ namespace Tizen.Uix.SttEngine public abstract Error CheckAppAgreed(string appid, out bool isAgreed); /// - /// Called when the engine service user checks whether Stt engine needs the application's credential. + /// Called when the engine service user checks whether STT engine needs the application's credential. /// - /// true if Stt engine needs the application's credential, otherwise false + /// true if the STT engine needs the application's credential, otherwise false. /// 4 public abstract bool NeedAppCredential(); @@ -406,39 +406,39 @@ namespace Tizen.Uix.SttEngine /// /// In this function, the engine service user's callback delegate 'ResultTime' is invoked repeatedly for sending the time information to the engine service user /// and user_data must be transferred to 'ResultTime'. If 'ResultTime' returns false, it should be stopped to call 'ResultTime'. - /// timeInfo is transferred from SendResult. The type of timeInfo is up to the Stt engine developer. + /// timeInfo is transferred from SendResult. The type of timeInfo is up to the STT engine developer. /// - /// The time information - /// The callback function - /// The user data which must be passed to the callback function ResultTime + /// The time information. + /// The callback function. + /// The user data, which must be passed to the callback function ResultTime. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// 3. InvalidParameter /// /// - /// SendResult will invoke this function + /// SendResult will invoke this function. /// /// - /// This function invokes ResultTime repeatedly for getting result time information. + /// This function invokes the ResultTime repeatedly for getting the result time information. /// /// 4 public abstract Error ForEachResultTime(IntPtr timeInfo, ResultTime callback, IntPtr userData); /// /// Called when the engine service user starts to recognize the recording data. - /// In this callback function, Stt engine must transfer the recognition result and userData to the engine service user using SendResult(). - /// Also, if Stt engine needs the application's credential, it sets the credential granted to the application. - /// - /// The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code - /// For example, "ko_KR" for Korean, "en_US" for American English - /// The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL" - /// The Application ID - /// The credential granted to the application - /// The user data to be passed to the callback function + /// In this callback function, the STT engine must transfer the recognition result and userData to the engine service user using SendResult(). + /// Also, if the STT engine needs the application's credential, it sets the credential granted to the application. + /// + /// The language is specified as an ISO 3166 alpha-2 two letter country-code followed by an ISO 639-1 for the two-letter language code. + /// For example, "ko_KR" for Korean, "en_US" for American English. + /// The recognition type, "stt.recognition.type.FREE", or "stt.recognition.type.FREE.PARTIAL". + /// The application ID. + /// The credential granted to the application. + /// The user data to be passed to the callback function. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// 3. InvalidParameter @@ -454,20 +454,20 @@ namespace Tizen.Uix.SttEngine /// /// Called when the engine service user sets and sends the recording data for speech recognition. - /// This callback function is called by the engine service user to send the recording data to Stt engine.The engine receives the recording data and uses for speech recognition. - /// this function should be returned immediately after recording data copy. + /// This callback function is called by the engine service user to send the recording data to the STT engine. The engine receives the recording data and uses for speech recognition. + /// This function should be returned immediately after recording data copy. /// - /// The recording data - /// The length of recording data + /// The recording data. + /// The length of the recording data. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// 3. InvalidParameter /// 4. OperationFailed /// /// - /// Start should succeed + /// Start should succeed. /// /// If the engine supports partial result, SendResult() should be invoked. /// 4 @@ -477,34 +477,34 @@ namespace Tizen.Uix.SttEngine /// Called when the engine service user stops to recognize the recording data. /// This callback function is called by the engine service user to stop recording and to get the recognition result. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// 3. OperationFailed /// 4. NetworkDown /// /// - /// Start should succeed + /// Start should succeed. /// - /// After processing of the engine, , SendResult() should be invoked. + /// After processing of the engine, SendResult() should be invoked. /// 4 public abstract Error Stop(); /// /// Called when the engine service user cancels to recognize the recording data. - /// This callback function is called by the engine service user to cancel to recognize the recording data.Also, when starting the recorder is failed, this function is called. + /// This callback function is called by the engine service user to cancel to recognize the recording data. Also, when starting the recorder is failed, this function is called. /// /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// - /// Stt engine is in recognition processing or recording. + /// The STT engine is in recognition processing or recording. /// 4 public abstract Error Cancel(); /// - /// Public Constructor + /// Public constructor. /// /// /// http://tizen.org/feature/speech.recognition @@ -517,8 +517,8 @@ namespace Tizen.Uix.SttEngine } /// - /// Main function for Speech-To-Text (STT) engine. - /// This function is the main function for operating Stt engine. + /// Main function for the Speech-To-Text (STT) engine. + /// This function is the main function for operating the STT engine. /// /// /// http://tizen.org/privilege/recorder @@ -530,11 +530,11 @@ namespace Tizen.Uix.SttEngine /// /// ServiceAppMain should be used for working the engine after this function. /// - /// The Number of Arguments - /// The Arguments Array - /// Thrown in case of Permission denied - /// Thrown in case of Not supported - /// thrown in case of Operation failure + /// The number of arguments. + /// The arguments array. + /// Thrown in case of permission denied. + /// Thrown in case of not supported. + /// Thrown in case of an operation failure. /// 4 public void EngineMain(int argc, string[] argv) { @@ -575,22 +575,22 @@ namespace Tizen.Uix.SttEngine /// http://tizen.org/feature/microphone /// /// - /// This API is used in SetRecordingData() and Stop(), when Stt engine sends the recognition result to the engine service user. - /// This function is called in the following situations; 1) after Stop() is called, 2) the end point of speech is detected from recording, or 3) partial result is occurred. - /// The recognition result must be transferred to the engine service user through this function. Also, timeInfo must be transferred to ForEachResultTime(). - /// The type of timeInfo is up to the Stt engine developer. + /// This API is used in SetRecordingData() and Stop(), when the STT engine sends the recognition result to the engine service user. + /// This function is called in the following situations: 1) After Stop() is called, 2) The end point of speech is detected from recording, or 3) Partial result is occurred. + /// The recognition result must be transferred to the engine service user through this function. Also, the timeInfo must be transferred to ForEachResultTime(). + /// The type of timeInfo is up to the STT engine developer. /// - /// The result event - /// The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL" - /// Result texts - /// Result text count - /// Engine message - /// The time information - /// Thrown in case of Permission denied - /// Thrown in case of Not supported - /// thrown in case of Operation failure + /// The result event. + /// The recognition type, "stt.recognition.type.FREE", or "stt.recognition.type.FREE.PARTIAL". + /// Result texts. + /// Result text count. + /// Engine message. + /// The time information. + /// Thrown in case of permission denied. + /// Thrown in case of not supported. + /// Thrown in case of an operation failure. /// - /// EngineMain function should be invoked before this function is called. Stop will invoke this function. + /// The EngineMain function should be invoked before this function is called. Stop will invoke this function. /// /// /// This function invokes ForEachResultTime @@ -654,13 +654,13 @@ namespace Tizen.Uix.SttEngine /// http://tizen.org/feature/speech.recognition /// http://tizen.org/feature/microphone /// - /// The Error Reason - /// The error message - /// Thrown in case of Permission denied - /// Thrown in case of Not supported - /// Thrown in case of Operation failure + /// The error reason. + /// The error message. + /// Thrown in case of permission denied. + /// Thrown in case of not supported. + /// Thrown in case of an operation failure. /// - /// Main function should be invoked before this function is called. + /// The main function should be invoked before this function is called. /// /// 4 public void SendError(Error error, string msg) @@ -674,21 +674,21 @@ namespace Tizen.Uix.SttEngine } /// - /// Sends the speech status to the engine service user when Stt engine notifies the change of the speech status. + /// Sends the speech status to the engine service user when the STT engine notifies the change of the speech status. /// /// /// http://tizen.org/feature/speech.recognition /// http://tizen.org/feature/microphone /// /// - /// This API is invoked when Stt engine wants to notify the change of the speech status anytime. NOTE that this API can be invoked for recognizing the speech. + /// This API is invoked when the STT engine wants to notify the change of the speech status anytime. Note that this API can be invoked for recognizing the speech. /// /// SpeechStatus - /// Thrown in case of Permission denied - /// Thrown in case of Not supported - /// thrown in case of Operation failure + /// Thrown in case of permission denied. + /// Thrown in case of not supported. + /// Thrown in case of an operation failure. /// - /// Main function should be invoked before this function is called. Start() and SetRecordingData() will invoke this function. + /// The main function should be invoked before this function is called. The Start() and SetRecordingData() will invoke this function. /// /// 4 public void SendSpeechStatus(SpeechStatus status) @@ -713,22 +713,22 @@ namespace Tizen.Uix.SttEngine /// http://tizen.org/feature/microphone /// /// - /// Called when Stt engine receives the private data from the engine service user. - /// This callback function is called when the engine service user sends the private data to Stt engine. + /// Called when the STT engine receives the private data from the engine service user. + /// This callback function is called when the engine service user sends the private data to the STT engine. /// In Parameters: /// a = Key -- The key field of private data /// b = data -- The data field of private data - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidParameter /// 3. OperationFailed /// - /// Thrown in case of Invalid Parameter - /// Thrown in case of Permission denied - /// Thrown in case of Not supported - /// thrown in case of Operation failure + /// Thrown in case of an invalid parameter. + /// Thrown in case of permission denied. + /// Thrown in case of not supported. + /// Thrown in case of an operation failure. /// - /// Main function should be invoked before this function is called. + /// The main function should be invoked before this function is called. /// /// 4 public void SetPrivateDataSetDelegate(Action callback) @@ -763,23 +763,23 @@ namespace Tizen.Uix.SttEngine /// http://tizen.org/feature/speech.recognition /// http://tizen.org/feature/microphone /// - /// callback function - /// Called when Stt engine provides the engine service user with the private data. - /// This callback function is called when the engine service user gets the private data from Stt engine. - /// Out Parameters: + /// The callback function. + /// Called when the STT engine provides the engine service user with the private data. + /// This callback function is called when the engine service user gets the private data from the STT engine. + /// Out parameters: /// a = Key -- The key field of private data /// b = data -- The data field of private data - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidParameter /// 3. OperationFailed /// - /// Thrown in case of Invalid Parameter - /// Thrown in case of Permission denied - /// Thrown in case of Not supported - /// thrown in case of Operation failure + /// Thrown in case of an invalid parameter. + /// Thrown in case of permission denied. + /// Thrown in case of not supported. + /// Thrown in case of an operation failure. /// - /// Main function should be invoked before this function is called. + /// The main function should be invoked before this function is called. /// /// 4 public void SetPrivateDataRequestedDelegate(OutAction callback) diff --git a/src/Tizen.Uix.TtsEngine/Interop/Interop.Libraries.cs b/src/Tizen.Uix.TtsEngine/Interop/Interop.Libraries.cs index 178808e..1088e9c 100755 --- a/src/Tizen.Uix.TtsEngine/Interop/Interop.Libraries.cs +++ b/src/Tizen.Uix.TtsEngine/Interop/Interop.Libraries.cs @@ -16,12 +16,12 @@ /// -/// Partial Interop Class +/// The Partial Interop class. /// internal static partial class Interop { /// - /// Partial Libraries Class + /// The Partial Libraries class. /// internal static partial class Libraries { diff --git a/src/Tizen.Uix.TtsEngine/Interop/Interop.TtsEngine.cs b/src/Tizen.Uix.TtsEngine/Interop/Interop.TtsEngine.cs index df37090..eab4715 100755 --- a/src/Tizen.Uix.TtsEngine/Interop/Interop.TtsEngine.cs +++ b/src/Tizen.Uix.TtsEngine/Interop/Interop.TtsEngine.cs @@ -21,12 +21,12 @@ using Tizen.Uix.TtsEngine; using static Tizen.Uix.TtsEngine.Engine; /// -/// Partial Interop Class +/// The Partial Interop class. /// internal static partial class Interop { /// - /// TtsEngine Interop Class + /// The TtsEngine Interop class. /// internal static class TtsEngine { diff --git a/src/Tizen.Uix.TtsEngine/Tizen.Uix.TtsEngine/TtsEngine.cs b/src/Tizen.Uix.TtsEngine/Tizen.Uix.TtsEngine/TtsEngine.cs index 87add04..25165dd 100755 --- a/src/Tizen.Uix.TtsEngine/Tizen.Uix.TtsEngine/TtsEngine.cs +++ b/src/Tizen.Uix.TtsEngine/Tizen.Uix.TtsEngine/TtsEngine.cs @@ -21,123 +21,123 @@ using static Interop.TtsEngine; namespace Tizen.Uix.TtsEngine { /// - /// Enumeration for audio type. + /// Enumeration for the audio types. /// /// 4 public enum AudioType { /// - /// Signed 16-bit audio type + /// Signed 16-bit audio type. /// RawS16 = 0, /// - /// Unsigned 8-bit audio type + /// Unsigned 8-bit audio type. /// RawU8, /// - /// Maximum Value + /// Maximum value. /// Max }; /// - /// Enumeration for result. + /// Enumeration for the results. /// /// 4 public enum ResultEvent { /// - /// Event when the voice synthesis is failed + /// Event when the voice synthesis fails. /// Fail = -1, /// - /// Event when the sound data is first data by callback function + /// Event when the sound data is the first data by the callback function. /// Start = 1, /// - /// Event when the next sound data exist, not first and not last + /// Event when the next sound data exists, not the first and the last. /// Continue = 2, /// - /// Event when the sound data is last data or sound data is only one result + /// Event when the sound data is the last data or the sound data is the only result. /// Finish = 3 }; /// - /// Enumeration for Voice Type + /// Enumeration for the voice types. /// /// 4 public enum VoiceType { /// - /// male voice type. + /// Male voice type. /// Male = 1, /// - /// female voice type. + /// Female voice type. /// Female = 2, /// - /// child's voice type. + /// Child's voice type. /// Child = 3 } /// - /// Enum for Error values that can occur + /// Enumeration for the error values that can occur. /// /// 4 public enum Error { /// - /// Successful, No error + /// Successful, no error. /// None = ErrorCode.None, /// - /// Out of Memory + /// Out of memory. /// OutOfMemory = ErrorCode.OutOfMemory, /// - /// I/O error + /// I/O error. /// IoError = ErrorCode.IoError, /// - /// Invalid parameter + /// Invalid parameter. /// InvalidParameter = ErrorCode.InvalidParameter, /// - /// Network down(Out of network) + /// Network down (Out of network). /// NetworkDown = ErrorCode.NetworkDown, /// - /// Invalid state + /// Invalid state. /// InvalidState = ErrorCode.InvalidState, /// - /// Invalid voice + /// Invalid voice. /// InvalidVoice = ErrorCode.InvalidVoice, /// - /// Operation failed + /// Operation failed. /// OperationFailed = ErrorCode.OperationFailed, /// - /// Not supported feature of current engine + /// Not supported feature of the current engine. /// NotSupportedFeature = ErrorCode.NotSupportedFeature, /// - /// NOT supported + /// Not supported. /// NotSupported = ErrorCode.NotSupported, /// - /// Permission denied + /// Permission denied. /// PermissionDenied = ErrorCode.PermissionDenied }; /// - /// This Class represents the Tts Engine which has to be inherited to make the engine. + /// This class represents the TTS engine, which has to be inherited to make the engine. /// /// 4 public abstract class Engine @@ -151,37 +151,37 @@ namespace Tizen.Uix.TtsEngine private IntPtr _structIntPtrHandle; /// - /// An Action with 2 Input Parameter returning a Error + /// An action with 2 input parameters returning an error. /// - /// Generic Type for Parameter 1 - /// The Input Parameter 1 - /// The Input Parameter 2 - /// Error Value + /// Generic type for parameter 1. + /// The input parameter 1. + /// The input parameter 2. + /// Error value. /// 4 public delegate Error Action(T a, T b); /// - /// An Action with 2 Out Parameter returning a Error + /// An action with 2 out parameters returning an error. /// - /// Generic Type for Parameter 1 - /// The Input Parameter 1 - /// The Input Parameter 2 - /// Error Value + /// Generic type for parameter 1. + /// The input parameter 1. + /// The input parameter 2. + /// Error value. /// 4 public delegate Error OutAction(T a, out T b); /// - /// Called when TTS engine informs the engine service user about whole supported language and voice type list. - /// This callback function is implemented by the engine service user.Therefore, the engine developer does NOT have to implement this callback function. + /// Called when the TTS engine informs the engine service user about whole supported language and voice type list. + /// This callback function is implemented by the engine service user, therefore, the engine developer does NOT have to implement this callback function. /// /// /// This callback function is called by ForEachSupportedVoices() to inform the whole supported voice list. userData must be transferred from ForEachSupportedVoices(). /// - /// The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code. - /// For example, "ko_KR" for Korean, "en_US" for American English - /// The voice type - /// The user data passed from ForEachSupportedVoices() - /// true to continue with the next iteration of the loop false to break out of the loop + /// The language is specified as an ISO 3166 alpha-2 two-letter country code followed by an ISO 639-1 for the two-letter language code. + /// For example, "ko_KR" for Korean, "en_US" for American English. + /// The voice type. + /// The user data passed from ForEachSupportedVoices(). + /// true to continue with the next iteration of the loop, false to break out of the loop. /// ForEachSupportedVoices() will invoke this callback function. /// 4 public delegate bool SupportedVoice(string language, VoiceType type, IntPtr userData); @@ -190,19 +190,19 @@ namespace Tizen.Uix.TtsEngine /// Called when the engine service user starts to synthesize a voice, asynchronously. /// /// - /// In this callback function, TTS engine must transfer the synthesized result to the engine service user using SendResult(). - /// Also, if TTS engine needs the application's credential, it can set the credential granted to the application. + /// In this callback function, the TTS engine must transfer the synthesized result to the engine service user using SendResult(). + /// Also, if the TTS engine needs the application's credential, it can set the credential granted to the application. /// - /// The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code. - /// For example, "ko_KR" for Korean, "en_US" for American English - /// The voice type - /// Texts - /// The speed of speaking - /// The Application ID - /// The credential granted to the application - /// The user data which must be passed to SendResult() function + /// The language is specified as an ISO 3166 alpha-2 two-letter country code followed by an ISO 639-1 for the two-letter language code. + /// For example, "ko_KR" for Korean, "en_US" for American English. + /// The voice type. + /// Texts. + /// The speed of speaking. + /// The application ID. + /// The credential granted to the application. + /// The user data which must be passed to the SendResult() function. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// 3. InvalidParameter @@ -211,24 +211,24 @@ namespace Tizen.Uix.TtsEngine /// 6. NetworkDown /// 7. PermissionDenied /// - /// This function invokes SendResult() + /// This function invokes SendResult(). /// 4 public abstract Error StartSynthesis(string language, int type, string text, int speed, string appid, string credential, IntPtr userData); /// - /// Called when the engine service user requests the basic information of TTS engine. + /// Called when the engine service user requests the basic information of the TTS engine. /// /// /// The allocated engineUuid, engineName, and engineSetting will be released internally. - /// In order to upload the engine at Tizen Appstore, both a service app and a ui app are necessary. + /// In order to upload the engine at Tizen Appstore, both a service application and a UI application are necessary. /// Therefore, engineSetting must be transferred to the engine service user. /// - /// UUID of engine - /// Name of engine - /// The engine setting application(ui app)'s app ID - /// The status for using network + /// UUID of the engine. + /// Name of the engine. + /// The engine setting application (UI application)'s ID. + /// The status for using the network. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// @@ -236,10 +236,10 @@ namespace Tizen.Uix.TtsEngine public abstract Error GetInformation(out string engineUuid, out string engineName, out string engineSetting, out bool useNetwork); /// - /// Called when the engine service user initializes TTS engine. + /// Called when the engine service user initializes the TTS engine. /// /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// 3. NotSupportedFeature @@ -249,13 +249,13 @@ namespace Tizen.Uix.TtsEngine public abstract Error Initialize(); /// - /// Called when the engine service user deinitializes TTS engine. + /// Called when the engine service user deinitializes the TTS engine. /// /// - /// NOTE that the engine may be terminated automatically. When this callback function is invoked, the release of resources is necessary. + /// NOTE that the engine may be terminated automatically. When this callback function is invoked, the release of the resources is necessary. /// /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// @@ -266,28 +266,28 @@ namespace Tizen.Uix.TtsEngine /// Called when the engine service user gets the whole supported voice list. /// /// - /// In this function, the engine service user's callback function 'SupportedVoice()' is invoked repeatedly for getting all supported voices, + /// In this function, the engine service user's callback function 'SupportedVoice()' is invoked repeatedly for getting all the supported voices, /// and userData must be transferred to 'SupportedVoice()'. If 'SupportedVoice()' returns false, it should be stopped to call 'SupportedVoice()'. - /// The callback function - /// The user data which must be passed to SupportedVoice() + /// The callback function. + /// The user data which must be passed to SupportedVoice(). /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. OperationFailed /// - /// This callback function invokes SupportedVoice() repeatedly for getting all supported voices. + /// This callback function invokes SupportedVoice() repeatedly for getting all the supported voices. /// 4 public abstract Error ForEachSupportedVoices(SupportedVoice callback, IntPtr userData); /// - /// Called when the engine service user checks whether the voice is valid or not in TTS engine. + /// Called when the engine service user checks whether the voice is valid or not in the TTS 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 - /// The voice type - /// A variable for checking whether the corresponding voice is valid or not. true to be valid, false to be invalid + /// The language is specified as an ISO 3166 alpha-2 two-letter country code followed by an ISO 639-1 for the two-letter language code. + /// For example, "ko_KR" for Korean, "en_US" for American English. + /// The voice type. + /// A variable for checking whether the corresponding voice is valid or not. true to be valid, false to be invalid. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidParameter /// @@ -295,11 +295,11 @@ namespace Tizen.Uix.TtsEngine public abstract Error IsValidVoice(string language, int type, out bool isValid); /// - /// Called when the engine service user sets the default pitch of TTS engine. + /// Called when the engine service user sets the default pitch of the TTS engine. /// - /// The default pitch + /// The default pitch. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// 3. OperationFailed @@ -311,11 +311,11 @@ namespace Tizen.Uix.TtsEngine /// /// Called when the engine service user requests to load the corresponding voice type for the first time. /// - /// The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code. - /// For example, "ko_KR" for Korean, "en_US" for American English - /// The voice type + /// The language is specified as an ISO 3166 alpha-2 two-letter country code followed by an ISO 639-1 for the two-letter language code. + /// For example, "ko_KR" for Korean, "en_US" for American English. + /// The voice type. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// 3. OperationFailed @@ -329,11 +329,11 @@ namespace Tizen.Uix.TtsEngine /// /// Called when the engine service user requests to unload the corresponding voice type or to stop using voice. /// - /// The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code. - /// For example, "ko_KR" for Korean, "en_US" for American English - /// The voice type + /// The language is specified as an ISO 3166 alpha-2 two-letter country code followed by an ISO 639-1 for the two-letter language code. + /// For example, "ko_KR" for Korean, "en_US" for American English. + /// The voice type. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// 3. OperationFailed @@ -344,20 +344,20 @@ namespace Tizen.Uix.TtsEngine public abstract Error UnloadVoice(string language, int type); /// - /// Called when the engine service user requests for TTS engine to check whether the application agreed the usage of TTS engine. - /// This callback function is called when the engine service user requests for TTS engine to check the application's agreement about using the engine. + /// Called when the engine service user requests for the TTS engine to check whether the application agreed the usage of the TTS engine. + /// This callback function is called when the engine service user requests for the TTS engine to check the application's agreement about using the the engine. /// According to the need, the engine developer can provide some user interfaces to check the agreement. /// /// - /// If the TTS engine developer wants not to check the agreement, the developer has need to return proper values as isAgreed in accordance with the intention. + /// If the TTS engine developer does not want to check the agreement, the developer needs to return proper values as isAgreed in accordance with the intention. /// true if the developer regards that every application agreed the usage of the engine, false if the developer regards that every application disagreed. /// NOTE that, however, there may be any legal issue unless the developer checks the agreement. /// Therefore, we suggest that the engine developers should provide a function to check the agreement. /// - /// The Application ID - /// A variable for checking whether the application agreed to use TTS engine or not. true to agree, false to disagree + /// The application ID. + /// A variable for checking whether the application agreed to use the TTS engine or not. true to agree, false to disagree. /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// 3. NotSupportedFeature @@ -367,9 +367,9 @@ namespace Tizen.Uix.TtsEngine public abstract Error CheckAppAgreed(string appid, out bool isAgreed); /// - /// Called when the engine service user checks whether TTS engine needs the application's credential. + /// Called when the engine service user checks whether the TTS engine needs the application's credentials. /// - /// true if TTS engine needs the application's credential, otherwise false + /// true if TTS engine needs the application's credentials, otherwise false. /// 4 public abstract bool NeedAppCredential(); @@ -377,18 +377,18 @@ namespace Tizen.Uix.TtsEngine /// Called when the engine service user cancels to synthesize a voice. /// /// - /// Following Error Codes can be returned + /// The following error codes can be returned: /// 1. None /// 2. InvalidState /// /// - /// StartSynthesis should be performed + /// StartSynthesis should be performed. /// /// 4 public abstract Error CancelSynthesis(); /// - /// Public Constructor + /// Public constructor. /// /// /// http://tizen.org/feature/speech.synthesis @@ -400,8 +400,8 @@ namespace Tizen.Uix.TtsEngine } /// - /// Main function for Text-To-Speech (TTS) engine. - /// This function is the main function for operating TTS engine. + /// Main function for the Text-To-Speech (TTS) engine. + /// This function is the main function for operating the TTS engine. /// /// /// http://tizen.org/feature/speech.synthesis @@ -409,10 +409,10 @@ namespace Tizen.Uix.TtsEngine /// /// ServiceAppMain should be used for working the engine after this function. /// - /// The argument count(original) - /// The argument(original) - /// Thrown in case of Not supported - /// thrown in case of Operation failure + /// The argument count (original). + /// The argument (original). + /// Thrown in case of not supported. + /// Thrown in case of operation failure. /// 4 public void EngineMain(int argc, string[] argv) { @@ -442,19 +442,19 @@ namespace Tizen.Uix.TtsEngine } /// - /// Gets the speed range from Tizen platform + /// Gets the speed range from the Tizen platform. /// /// /// http://tizen.org/feature/speech.synthesis /// /// - /// This API is used when TTS engine wants to get the speed range from Tizen platform + /// This API is used when the TTS engine wants to get the speed range from the Tizen platform. /// - /// The minimum speed value - /// The normal speed value - /// The maximum speed value - /// Thrown in case of Not supported - /// thrown in case of Operation failure + /// The minimum speed value. + /// The normal speed value. + /// The maximum speed value. + /// Thrown in case of not supported. + /// Thrown in case of operation failure. /// 4 public void GetSpeedRange(out int min, out int normal, out int max) { @@ -468,19 +468,19 @@ namespace Tizen.Uix.TtsEngine } /// - /// Gets the pitch range from Tizen platform. + /// Gets the pitch range from the Tizen platform. /// /// /// http://tizen.org/feature/speech.synthesis /// /// - /// This API is used when TTS engine wants to get the pitch range from Tizen platform. + /// This API is used when the TTS engine wants to get the pitch range from the Tizen platform. /// - /// The minimum pitch value - /// The normal pitch value - /// The maximum pitch value - /// Thrown in case of Not supported - /// thrown in case of Operation failure + /// The minimum pitch value. + /// The normal pitch value. + /// The maximum pitch value. + /// Thrown in case of not supported. + /// Thrown in case of operation failure. /// 4 public void GetPitchRange(out int min, out int normal, out int max) { @@ -500,17 +500,17 @@ namespace Tizen.Uix.TtsEngine /// http://tizen.org/feature/speech.synthesis /// /// - /// This API is used in StartSynthesis(), when TTS engine sends the synthesized result to the engine service user. + /// This API is used in StartSynthesis(), when the TTS engine sends the synthesized result to the engine service user. /// The synthesized result must be transferred to the engine service user through this function. /// - /// The result event - /// Result data - /// Result data size - /// The audio type - /// The sample rate - /// Thrown in case of Invalid Parameter - /// Thrown in case of Not supported - /// thrown in case of Operation failure + /// The result event. + /// The result data. + /// The result data size. + /// The audio type. + /// The sample rate. + /// Thrown in case of an invalid parameter. + /// Thrown in case of not supported. + /// Thrown in case of operation failure. /// /// EngineMain function should be invoked before this function is called. StartSynthesis() will invoke this function. /// @@ -531,10 +531,10 @@ namespace Tizen.Uix.TtsEngine /// /// http://tizen.org/feature/speech.synthesis /// - /// The error reason - /// The error message - /// Thrown in case of Not supported - /// thrown in case of Operation failure + /// The error reason. + /// The error message. + /// Thrown in case of not supported. + /// Thrown in case of operation failure. /// /// EngineMain function should be invoked before this function is called. /// @@ -557,19 +557,19 @@ namespace Tizen.Uix.TtsEngine /// http://tizen.org/feature/speech.synthesis /// /// - /// Called when the engine service user gets the private data from Tts engine. - /// In Parameters: - /// a = Key -- The key field of private data - /// b = data -- The data field of private data - /// Following Error Codes can be returned + /// Called when the engine service user gets the private data from the TTS engine. + /// In parameters: + /// a = Key -- The key field of private data. + /// b = data -- The data field of private data. + /// The following error codes can be returned: /// 1. None /// 2. InvalidParameter /// 3. OperationFailed /// 4. NotSupported /// - /// Thrown in case of Invalid Parameter - /// Thrown in case of Not supported - /// thrown in case of Operation failure + /// Thrown in case of an invalid parameter. + /// Thrown in case of not supported. + /// thrown in case of operation failure. /// /// Main function should be invoked before this function is called. /// @@ -602,21 +602,21 @@ namespace Tizen.Uix.TtsEngine /// /// http://tizen.org/feature/speech.synthesis /// - /// callback function - /// Called when TTS engine receives the private data from the engine service user. - /// This callback function is called when the engine service user sends the private data to TTS engine. - /// Out Parameters: - /// a = Key -- The key field of private data - /// b = data -- The data field of private data - /// Following Error Codes can be returned + /// The callback function. + /// Called when the TTS engine receives the private data from the engine service user. + /// This callback function is called when the engine service user sends the private data to the TTS engine. + /// Out parameters: + /// a = Key -- The key field of private data. + /// b = data -- The data field of private data. + /// The following error codes can be returned: /// 1. None /// 2. InvalidParameter /// 3. OperationFailed /// 4. NotSupported /// - /// Thrown in case of Invalid Parameter - /// Thrown in case of Not supported - /// thrown in case of Operation failure + /// Thrown in case of an invalid parameter. + /// Thrown in case of not supported. + /// thrown in case of operation failure. /// /// Main function should be invoked before this function is called. /// -- 2.7.4