From df3fce32a95716f1a4f61d7411523cb10819aca9 Mon Sep 17 00:00:00 2001 From: Surbhi Gupta <35525588+surbhig12@users.noreply.github.com> Date: Tue, 4 Sep 2018 06:09:31 +0530 Subject: [PATCH] English Review: NUI public files (#434) --- src/Tizen.NUI/src/public/BaseHandle.cs | 4 +- src/Tizen.NUI/src/public/FontClient.cs | 40 +++++------ src/Tizen.NUI/src/public/ImageLoading.cs | 38 +++++----- src/Tizen.NUI/src/public/ImfManager.cs | 4 +- src/Tizen.NUI/src/public/InputMethodContext.cs | 72 +++++++++---------- .../src/public/LongPressGestureDetector.cs | 20 +++--- src/Tizen.NUI/src/public/NUIApplication.cs | 24 +++---- src/Tizen.NUI/src/public/NUIConstants.cs | 32 ++++----- src/Tizen.NUI/src/public/PanGestureDetector.cs | 2 +- src/Tizen.NUI/src/public/PinchGestureDetector.cs | 6 +- src/Tizen.NUI/src/public/PixelBuffer.cs | 82 +++++++++++----------- src/Tizen.NUI/src/public/PixelData.cs | 8 +-- src/Tizen.NUI/src/public/Property.cs | 2 +- src/Tizen.NUI/src/public/StyleManager.cs | 4 +- src/Tizen.NUI/src/public/TapGestureDetector.cs | 2 +- src/Tizen.NUI/src/public/Touch.cs | 14 ++-- src/Tizen.NUI/src/public/VisualMaps.cs | 28 ++++---- src/Tizen.NUI/src/public/Window.cs | 16 ++--- 18 files changed, 199 insertions(+), 199 deletions(-) diff --git a/src/Tizen.NUI/src/public/BaseHandle.cs b/src/Tizen.NUI/src/public/BaseHandle.cs index 214f758..14be715 100755 --- a/src/Tizen.NUI/src/public/BaseHandle.cs +++ b/src/Tizen.NUI/src/public/BaseHandle.cs @@ -30,7 +30,7 @@ namespace Tizen.NUI public class BaseHandle : Element, global::System.IDisposable { /// - /// Event which is occurred when a property is set + /// Event when a property is set. /// /// 5 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. @@ -335,7 +335,7 @@ namespace Tizen.NUI /// /// Gets the the hash code of this baseHandle. /// - /// The Hash Code. + /// The hash code. /// 5 public override int GetHashCode() { diff --git a/src/Tizen.NUI/src/public/FontClient.cs b/src/Tizen.NUI/src/public/FontClient.cs index 5d494e4..9744511 100755 --- a/src/Tizen.NUI/src/public/FontClient.cs +++ b/src/Tizen.NUI/src/public/FontClient.cs @@ -104,14 +104,14 @@ namespace Tizen.NUI if (type == DisposeTypes.Explicit) { - //Called by User + //Called by User. //Release your own managed resources here. //You should release all of your own disposable objects here. } //Release your own unmanaged resources here. //You should not access any managed member here except static instance. - //because the execution order of Finalizes is non-deterministic. + //Because the execution order of Finalizes is non-deterministic. if (swigCPtr.Handle != global::System.IntPtr.Zero) { @@ -195,7 +195,7 @@ namespace Tizen.NUI private static readonly FontClient instance = FontClient.Get(); /// - /// Gets the singleton of the FontClient object. + /// Gets the singleton pattern of the FontClient object. /// /// 5 public static FontClient Instance @@ -300,7 +300,7 @@ namespace Tizen.NUI /// Whether the given character is supported by the font. /// /// The id of the font. - /// The character. + /// The character in a font. /// True if the character is supported by the font. /// 5 public bool IsCharacterSupportedByFont(uint fontId, uint character) @@ -311,12 +311,12 @@ namespace Tizen.NUI } /// - /// Find the default font for displaying a UTF-32 character. + /// Finds the default font for displaying a UTF-32 character. /// /// The character for which a font is needed. - /// The point size in 26.6 fractional points; the default point size is 12*64. + /// The point size in 26.6 fractional points. The default point size is 12*64. /// True if a color font is preferred. - /// A valid font identifier, or zero if the font does not exist. + /// A valid font identifier. Zero if the font does not exist. /// 5 public uint FindDefaultFont(uint charcode, uint requestedPointSize, bool preferColor) { @@ -329,8 +329,8 @@ namespace Tizen.NUI /// Find the default font for displaying a UTF-32 character. /// /// The character for which a font is needed. - /// The point size in 26.6 fractional points; the default point size is 12*64. - /// A valid font identifier, or zero if the font does not exist. + /// The point size in 26.6 fractional points. The default point size is 12*64. + /// A valid font identifier. Zero if the font does not exist. /// 5 public uint FindDefaultFont(uint charcode, uint requestedPointSize) { @@ -343,7 +343,7 @@ namespace Tizen.NUI /// Find the default font for displaying a UTF-32 character. /// /// The character for which a font is needed. - /// A valid font identifier, or zero if the font does not exist. + /// A valid font identifier. Zero if the font does not exist. /// 5 public uint FindDefaultFont(uint charcode) { @@ -374,12 +374,12 @@ namespace Tizen.NUI } /// - /// Retrieve the unique identifier for a font.. + /// Retrieve the unique identifier for a font. /// /// The path to a font file. - /// The point size in 26.6 fractional points; the default point size is 12*64. + /// The point size in 26.6 fractional points. The default point size is 12*64. /// The index of the font face. - /// A valid font identifier, or zero if the font does not exist. + /// A valid font identifier. Zero if the font does not exist. /// 5 public uint GetFontId(string path, uint requestedPointSize, uint faceIndex) { @@ -389,11 +389,11 @@ namespace Tizen.NUI } /// - /// Retrieve the unique identifier for a font.. + /// Retrieve the unique identifier for a font. /// /// The path to a font file. - /// The point size in 26.6 fractional points; the default point size is 12*64. - /// A valid font identifier, or zero if the font does not exist. + /// The point size in 26.6 fractional points. The default point size is 12*64. + /// A valid font identifier. Zero if the font does not exist. /// 5 public uint GetFontId(string path, uint requestedPointSize) { @@ -403,10 +403,10 @@ namespace Tizen.NUI } /// - /// Retrieve the unique identifier for a font.. + /// Retrieve the unique identifier for a font. /// /// The path to a font file. - /// A valid font identifier, or zero if the font does not exist. + /// A valid font identifier. Zero if the font does not exist. /// 5 public uint GetFontId(string path) { @@ -439,7 +439,7 @@ namespace Tizen.NUI /// /// Check to see if a font is scalable. /// - /// Path The path to a font file. + /// The path where the font file is located. /// True if scalable. /// 5 public bool IsScalable(string path) @@ -529,7 +529,7 @@ namespace Tizen.NUI } /// - /// Add custom fonts directory. + /// Adds custom fonts directory. /// /// Path to the fonts directory. /// True if the fonts can be added. diff --git a/src/Tizen.NUI/src/public/ImageLoading.cs b/src/Tizen.NUI/src/public/ImageLoading.cs index b04a085..cc815e6 100755 --- a/src/Tizen.NUI/src/public/ImageLoading.cs +++ b/src/Tizen.NUI/src/public/ImageLoading.cs @@ -23,7 +23,7 @@ namespace Tizen.NUI /// Loading an image. /// /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public class ImageLoading { @@ -37,7 +37,7 @@ namespace Tizen.NUI /// Reorient the image to respect any orientation metadata in its header. /// Handle to the loaded PixelBuffer object or an empty handle in case loading failed. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public static PixelBuffer LoadImageFromFile(string url, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode, bool orientationCorrection) { @@ -74,7 +74,7 @@ namespace Tizen.NUI /// The method used to fit the shape of the image before loading to the shape defined by the size parameter. /// Handle to the loaded PixelBuffer object or an empty handle in case loading failed. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public static PixelBuffer LoadImageFromFile(string url, Size2D size, FittingModeType fittingMode) { @@ -91,7 +91,7 @@ namespace Tizen.NUI /// The width and height to fit the loaded image to, 0.0 means whole image. /// Handle to the loaded PixelBuffer object or an empty handle in case loading failed. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public static PixelBuffer LoadImageFromFile(string url, Size2D size) { @@ -107,7 +107,7 @@ namespace Tizen.NUI /// The URL of the image file to load. /// Handle to the loaded PixelBuffer object or an empty handle in case loading failed. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public static PixelBuffer LoadImageFromFile(string url) { @@ -120,13 +120,13 @@ namespace Tizen.NUI /// Determine the size of an image that LoadImageFromFile will provide when given the same image loading parameters. /// /// The name of the image. - /// The requested size for the image + /// The requested size for the image. /// The method to use to map the source image to the desired dimensions. /// The image filter to use if the image needs to be downsampled to the requested size. - /// Whether to use image metadata to rotate or flip the image, e.g., from portrait to landscape. + /// Whether to use image metadata to rotate or flip the image, for example, from portrait to landscape. /// Dimensions that image will have if it is loaded with given parameters. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public static Size2D GetClosestImageSize(string filename, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode, bool orientationCorrection) { @@ -146,7 +146,7 @@ namespace Tizen.NUI /// The image filter to use if the image needs to be downsampled to the requested size. /// Dimensions that image will have if it is loaded with given parameters. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public static Size2D GetClosestImageSize(string filename, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode) { @@ -165,7 +165,7 @@ namespace Tizen.NUI /// The method to use to map the source image to the desired dimensions. /// Dimensions that image will have if it is loaded with given parameters. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public static Size2D GetClosestImageSize(string filename, Size2D size, FittingModeType fittingMode) { @@ -183,7 +183,7 @@ namespace Tizen.NUI /// The requested size for the image /// Dimensions that image will have if it is loaded with given parameters. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public static Size2D GetClosestImageSize(string filename, Size2D size) { @@ -200,7 +200,7 @@ namespace Tizen.NUI /// The name of the image. /// Dimensions that image will have if it is loaded with given parameters. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public static Size2D GetClosestImageSize(string filename) { @@ -220,7 +220,7 @@ namespace Tizen.NUI /// Reorient the image to respect any orientation metadata in its header. /// Handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public static PixelBuffer DownloadImageSynchronously(string url, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode, bool orientationCorrection) { @@ -239,7 +239,7 @@ namespace Tizen.NUI /// The filtering method used when sampling pixels from the input image while fitting it to desired size. /// Handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public static PixelBuffer DownloadImageSynchronously(string url, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode) { @@ -257,7 +257,7 @@ namespace Tizen.NUI /// The method used to fit the shape of the image before loading to the shape defined by the size parameter. /// Handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public static PixelBuffer DownloadImageSynchronously(string url, Size2D size, FittingModeType fittingMode) { @@ -274,7 +274,7 @@ namespace Tizen.NUI /// The width and height to fit the loaded image to, 0.0 means whole image. /// Handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public static PixelBuffer DownloadImageSynchronously(string url, Size2D size) { @@ -290,7 +290,7 @@ namespace Tizen.NUI /// The URL of the image file to load. /// Handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public static PixelBuffer DownloadImageSynchronously(string url) { @@ -304,7 +304,7 @@ namespace Tizen.NUI /// /// The maximum texture size to set. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public static void SetMaxTextureSize(uint size) { @@ -317,7 +317,7 @@ namespace Tizen.NUI /// /// The maximum texture size. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public static uint GetMaxTextureSize() { diff --git a/src/Tizen.NUI/src/public/ImfManager.cs b/src/Tizen.NUI/src/public/ImfManager.cs index c101267..8f68927 100755 --- a/src/Tizen.NUI/src/public/ImfManager.cs +++ b/src/Tizen.NUI/src/public/ImfManager.cs @@ -54,7 +54,7 @@ namespace Tizen.NUI } /// - /// Dispose + /// Dispose. /// /// Dispose Type /// 3 @@ -527,7 +527,7 @@ namespace Tizen.NUI } /// - /// Destroy the context of the IMF.
+ /// Destroys the context of the IMF.
/// /// 5 public void DestroyContext() diff --git a/src/Tizen.NUI/src/public/InputMethodContext.cs b/src/Tizen.NUI/src/public/InputMethodContext.cs index ae10445..e7e5794 100755 --- a/src/Tizen.NUI/src/public/InputMethodContext.cs +++ b/src/Tizen.NUI/src/public/InputMethodContext.cs @@ -22,7 +22,7 @@ using System.ComponentModel; namespace Tizen.NUI { /// - /// Specifically manages the input method framework which enables the virtual or hardware keyboards. + /// Specifically manages the input method framework (IMF) that enables the virtual or hardware keyboards. /// /// 5 public class InputMethodContext : BaseHandle @@ -57,7 +57,7 @@ namespace Tizen.NUI if (type == DisposeTypes.Explicit) { - //Called by User + //Called by User. //Release your own managed resources here. //You should release all of your own disposable objects here. @@ -65,7 +65,7 @@ namespace Tizen.NUI //Release your own unmanaged resources here. //You should not access any managed member here except static instance. - //because the execution order of Finalizes is non-deterministic. + //Because the execution order of Finalizes is non-deterministic. if (_keyboardTypeChangedEventCallback != null) { @@ -109,10 +109,10 @@ namespace Tizen.NUI return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, IntPtr.Zero) : obj.swigCPtr; } - //A Flag to check who called Dispose(). (By User or DisposeQueue) + //A flag to check who called Dispose(). (By User or DisposeQueue) private bool isDisposeQueued = false; /// - /// A Flat to check if it is already disposed. + /// A flag to check if it is already disposed. /// /// 5 protected bool disposed = false; @@ -166,7 +166,7 @@ namespace Tizen.NUI if (type == DisposeTypes.Explicit) { - //Called by User + //Called by User. //Release your own managed resources here. //You should release all of your own disposable objects here. @@ -328,7 +328,7 @@ namespace Tizen.NUI //A Flag to check who called Dispose(). (By User or DisposeQueue) private bool isDisposeQueued = false; /// - /// A Flat to check if it is already disposed. + /// A Flag to check if it is already disposed. /// /// 5 protected bool disposed = false; @@ -383,7 +383,7 @@ namespace Tizen.NUI if (type == DisposeTypes.Explicit) { - //Called by User + //Called by User. //Release your own managed resources here. //You should release all of your own disposable objects here. @@ -391,7 +391,7 @@ namespace Tizen.NUI //Release your own unmanaged resources here. //You should not access any managed member here except static instance. - //because the execution order of Finalizes is non-deterministic. + //Because the execution order of Finalizes is non-deterministic. if (swigCPtr.Handle != IntPtr.Zero) { @@ -455,7 +455,7 @@ namespace Tizen.NUI } /// - /// The current text string. + /// The current cursor position. /// /// 5 public int CursorPosition @@ -493,7 +493,7 @@ namespace Tizen.NUI } /// - /// Flags if preedit reset is required. + /// Flags if the pre-edit reset is required. /// /// 5 public bool PreeditResetRequired @@ -514,7 +514,7 @@ namespace Tizen.NUI } /// - /// Destroy the context of the IMF.
+ /// Destroys the context of the IMF.
/// /// 5 public void DestroyContext() @@ -524,7 +524,7 @@ namespace Tizen.NUI } /// - /// Destroy the context of the IMF.
+ /// Destroys the context of the IMF.
/// /// 5 /// Please do not use! This will be deprecated, instead please USE Tizen.NUI.InputMethodContext.Instance.DestroyContext()! @@ -562,8 +562,8 @@ namespace Tizen.NUI /// /// Activates the IMF.
- /// It means that the text editing is started somewhere.
- /// If the hardware keyboard isn't connected, then it will show the virtual keyboard. + /// It means that the text editing has started.
+ /// If the hardware keyboard is not connected, then it shows the virtual keyboard. /// /// 5 public void Activate() @@ -574,7 +574,7 @@ namespace Tizen.NUI /// /// Deactivates the IMF.
- /// It means that the text editing is finished somewhere. + /// It means that the text editing is complete. /// /// 5 public void Deactivate() @@ -584,8 +584,8 @@ namespace Tizen.NUI } /// - /// Gets the restoration status which controls if the keyboard is restored after the focus is lost and then regained.
- /// If true, then the keyboard will be restored (activated) after focus is regained. + /// Gets the restoration status, which controls if the keyboard is restored after the focus is lost and then regained.
+ /// If true, then the keyboard will be restored (activated) after the focus is regained. /// /// The restoration status. /// 5 @@ -599,7 +599,7 @@ namespace Tizen.NUI /// /// Sets the status whether the IMF has to restore the keyboard after losing focus. /// - /// True means that keyboard should be restored after the focus is lost and regained. + /// True means that keyboard must be restored after the focus is lost and regained. /// 5 public void SetRestoreAfterFocusLost(bool toggle) { @@ -608,7 +608,7 @@ namespace Tizen.NUI } /// - /// Sends a message reset to the preedit state or the IMF module. + /// Sends a message reset to the pre-edit state or the IMF module. /// /// 5 public new void Reset() @@ -618,7 +618,7 @@ namespace Tizen.NUI } /// - /// Notifies the IMF context that the cursor position has changed, required for features like auto-capitalization. + /// Notifies the IMF context that the cursor position has changed, required for features such as auto-capitalization. /// /// 5 public void NotifyCursorPosition() @@ -685,7 +685,7 @@ namespace Tizen.NUI } /// - /// Returns the text direction of the keyboard's current input language. + /// Returns the text direction of the current input language of the keyboard. /// /// The direction of the text. /// 5 @@ -701,9 +701,9 @@ namespace Tizen.NUI /// The position is relative to whether the keyboard is visible or not.
/// If the keyboard is not visible, then the position will be off the screen.
/// If the keyboard is not being shown when this method is called, the keyboard is partially setup (IMFContext) to get/> - /// the values then taken down. So ideally, GetInputMethodArea() should be called after Show(). + /// the values then taken down. So ideally, GetInputMethodArea() must be called after Show(). /// - /// Rectangle which is keyboard panel x, y, width, height. + /// Rectangle which is keyboard panel x, y, width, and height. /// 5 public Rectangle GetInputMethodArea() { @@ -719,7 +719,7 @@ namespace Tizen.NUI } /// - /// Sets up the input-panel specific data. + /// Sets up the input panel specific data. /// /// The specific data to be set to the input panel. /// 5 @@ -754,7 +754,7 @@ namespace Tizen.NUI /// /// Sets the return key on the input panel to be visible or invisible.
- /// The default is true. + /// The default value is true. /// /// True if the return key is visible (enabled), false otherwise. /// 5 @@ -810,7 +810,7 @@ namespace Tizen.NUI /// /// Gets the current language locale of the input panel.
- /// For example, en_US, en_GB, en_PH, fr_FR, ... + /// For example, en_US, en_GB, en_PH, fr_FR, and so on. /// /// The current language locale of the input panel. /// 5 @@ -835,7 +835,7 @@ namespace Tizen.NUI } /// - /// Gets/Sets whether the IM context allow to use the text prediction. + /// Gets or sets whether the IM context allows to use the text prediction. /// /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] @@ -923,7 +923,7 @@ namespace Tizen.NUI } /// - /// InputMethodContext event received event arguments. + /// InputMethodContext event receives event arguments. /// /// 5 public class EventReceivedEventArgs : EventArgs @@ -939,7 +939,7 @@ namespace Tizen.NUI } /// - /// EventData + /// EventData. /// /// 5 public EventData EventData @@ -1023,7 +1023,7 @@ namespace Tizen.NUI public class StatusChangedEventArgs : EventArgs { /// - /// InputMethodContext status + /// InputMethodContext status. /// /// 5 public bool StatusChanged @@ -1084,7 +1084,7 @@ namespace Tizen.NUI } /// - /// InputMethodContext resized event. + /// InputMethodContext resized event arguments. /// /// 5 public class ResizedEventArgs : EventArgs @@ -1150,13 +1150,13 @@ namespace Tizen.NUI } /// - /// InputMethodContext language changed event args. + /// InputMethodContext language changed event arguments. /// /// 5 public class LanguageChangedEventArgs : EventArgs { /// - /// language changed. + /// Language changed. /// /// 5 public int LanguageChanged @@ -1222,7 +1222,7 @@ namespace Tizen.NUI public class KeyboardTypeChangedEventArgs : EventArgs { /// - /// InputMethodContext keyboard type + /// InputMethodContext keyboard type. /// /// 5 public KeyboardType KeyboardType @@ -1310,7 +1310,7 @@ namespace Tizen.NUI /// 5 Void, /// - /// Pre-Edit changed. + /// Pre-edit changed. /// /// 5 Preedit, diff --git a/src/Tizen.NUI/src/public/LongPressGestureDetector.cs b/src/Tizen.NUI/src/public/LongPressGestureDetector.cs index 95ce253..052baf2 100755 --- a/src/Tizen.NUI/src/public/LongPressGestureDetector.cs +++ b/src/Tizen.NUI/src/public/LongPressGestureDetector.cs @@ -93,7 +93,7 @@ namespace Tizen.NUI private LongPressGesture _longPressGesture; /// - /// View - the attached view. + /// View the attached view. /// /// 5 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. @@ -145,7 +145,7 @@ namespace Tizen.NUI { lock (this) { - // Restricted to only one listener + // Restricted to only one listener. if (_longPressGestureEventHandler == null) { _longPressGestureEventHandler += value; @@ -174,13 +174,13 @@ namespace Tizen.NUI { DetectedEventArgs e = new DetectedEventArgs(); - // Populate all members of "e" (LongPressGestureEventArgs) with real data + // Populate all members of "e" (LongPressGestureEventArgs) with real data. e.View = Registry.GetManagedBaseHandleFromNativePtr(actor) as View; e.LongPressGesture = Tizen.NUI.LongPressGesture.GetLongPressGestureFromPtr(longPressGesture); if (_longPressGestureEventHandler != null) { - //here we send all data to user event handlers + //Here we send all data to user event handlers. _longPressGestureEventHandler(this, e); } @@ -208,7 +208,7 @@ namespace Tizen.NUI /// Creates an initialized LongPressGestureDetector with the number of touches required.
/// A long press gesture will be emitted from this detector if the number of fingers touching the screen is equal to the touches required.
/// - /// The number of touches required + /// The number of touches required. /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public LongPressGestureDetector(uint touchesRequired) : this(NDalicPINVOKE.LongPressGestureDetector_New__SWIG_1(touchesRequired), true) @@ -221,8 +221,8 @@ namespace Tizen.NUI /// Creates an initialized LongPressGestureDetector with the minimum and maximum number of touches required.
/// A long press gesture will be emitted from this detector if the number of fingers touching the screen falls between the minimum and maximum touches set.
/// - /// The minimum number of touches required - /// The maximum number of touches required + /// The minimum number of touches required. + /// The maximum number of touches required. /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public LongPressGestureDetector(uint minTouches, uint maxTouches) : this(NDalicPINVOKE.LongPressGestureDetector_New__SWIG_2(minTouches, maxTouches), true) @@ -258,7 +258,7 @@ namespace Tizen.NUI /// /// Sets the number of touches required.
- /// The number of touches corresponds to the number of fingers a user has on the screen. The default is 1.
+ /// The number of touches corresponds to the number of fingers a user has on the screen. The default value is 1.
/// /// Touches required /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. @@ -272,8 +272,8 @@ namespace Tizen.NUI /// /// Sets the minimum and maximum touches required. /// - /// Minimum Touches required - /// Maximum Touches required + /// Minimum touches required. + /// Maximum touches required. /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public void SetTouchesRequired(uint minTouches, uint maxTouches) diff --git a/src/Tizen.NUI/src/public/NUIApplication.cs b/src/Tizen.NUI/src/public/NUIApplication.cs index bd2d361..2737672 100755 --- a/src/Tizen.NUI/src/public/NUIApplication.cs +++ b/src/Tizen.NUI/src/public/NUIApplication.cs @@ -62,10 +62,10 @@ namespace Tizen.NUI private Size2D _windowSize2D = null; private Position2D _windowPosition2D = null; /// - /// The constructor with window size and position + /// The constructor with window size and position. /// - /// The window size - /// The window position + /// The window size. + /// The window position. /// 5 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] @@ -87,11 +87,11 @@ namespace Tizen.NUI } /// - /// The constructor with a stylesheet, window size and position + /// The constructor with a stylesheet, window size, and position. /// - /// The styleSheet url. - /// The window size - /// The window position + /// The styleSheet URL. + /// The window size. + /// The window position. /// 5 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] @@ -114,12 +114,12 @@ namespace Tizen.NUI } /// - /// The constructor with a stylesheet, window mode, window size and position + /// The constructor with a stylesheet, window mode, window size, and position. /// - /// The styleSheet url - /// The windowMode - /// The window size - /// The window position + /// The styleSheet URL. + /// The windowMode. + /// The window size. + /// The window position. /// 5 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] diff --git a/src/Tizen.NUI/src/public/NUIConstants.cs b/src/Tizen.NUI/src/public/NUIConstants.cs index 305209f..4aaefc0 100755 --- a/src/Tizen.NUI/src/public/NUIConstants.cs +++ b/src/Tizen.NUI/src/public/NUIConstants.cs @@ -651,18 +651,18 @@ namespace Tizen.NUI } /// - /// Specifies the Release Policy types
- /// Decides if the image should be cached in different conditions + /// Specifies the release policy types.
+ /// Decides if the image should be cached in different conditions. /// /// 5 public enum ReleasePolicyType { /// - /// Image is released when visual detached from scene + /// Image is released when visual detached from scene. /// Detached = 0, /// - /// Image is only released when visual is destroyed + /// Image is only released when visual is destroyed. /// Destroyed, /// @@ -672,8 +672,8 @@ namespace Tizen.NUI } /// - /// Specifies the Load Policy types
- /// Decides when the image texture should be loaded + /// Specifies the load policy types.
+ /// Decides when the image texture should be loaded. /// /// 5 public enum LoadPolicyType @@ -809,7 +809,7 @@ namespace Tizen.NUI } /// - /// The values of this enum determine how the visual should be fit to the view. + /// The values of this enum determines how the visual should fit into the view. /// /// 5 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. @@ -964,7 +964,7 @@ namespace Tizen.NUI /// Text, /// - /// Renders an n-patch image. + /// Renders an NPatch image. /// NPatch, /// @@ -1299,23 +1299,23 @@ namespace Tizen.NUI /// 4 public static readonly int FrameDelay = NDalic.IMAGE_VISUAL_FRAME_DELAY; /// - /// The number of times the AnimatedImageVisual will be looped - /// Default -1. if less than 0, loop unlimited. else, loop loopCount times. + /// The number of times the AnimatedImageVisual will be looped. + /// The default is -1. If the value is less than 0, loop unlimited. Otherwise, loop loopCount times. /// /// 5 public static readonly int LoopCount = NDalic.IMAGE_VISUAL_LOOP_COUNT; /// - /// The policy to determine when an image should no longer be cached + /// The policy to determine when an image should no longer be cached. /// /// 5 public static readonly int ReleasePolicy = NDalic.IMAGE_VISUAL_RELEASE_POLICY; /// - /// The policy to determine when an image should be loaded + /// The policy to determine when an image should be loaded. /// /// 5 public static readonly int LoadPolicy = NDalic.IMAGE_VISUAL_LOAD_POLICY; /// - /// Determines if image orientation should be corrected so the image displays as it was intended + /// Determines if image orientation should be corrected so that the image displays as it was intended. /// /// 5 public static readonly int OrientationCorrection = NDalic.IMAGE_VISUAL_ORIENTATION_CORRECTION; @@ -2484,7 +2484,7 @@ namespace Tizen.NUI } /// - /// An enum of text direction. + /// An enum of text directions. /// /// 5 public enum TextDirection @@ -2503,7 +2503,7 @@ namespace Tizen.NUI } /// - /// An enum of vertical line alignment. + /// An enum of vertical line alignments. /// /// 5 public enum VerticalLineAlignment @@ -2722,7 +2722,7 @@ namespace Tizen.NUI } /// - /// Enumeration type for the glyph type + /// Enumeration type for the glyph type. /// /// 5 public enum GlyphType diff --git a/src/Tizen.NUI/src/public/PanGestureDetector.cs b/src/Tizen.NUI/src/public/PanGestureDetector.cs index 92b88ef..ffb8d77 100755 --- a/src/Tizen.NUI/src/public/PanGestureDetector.cs +++ b/src/Tizen.NUI/src/public/PanGestureDetector.cs @@ -81,7 +81,7 @@ namespace Tizen.NUI /// - /// Event arguments that passed via the PanGestureEvent signal. + /// Event arguments that are passed via the PanGestureEvent signal. /// /// 5 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. diff --git a/src/Tizen.NUI/src/public/PinchGestureDetector.cs b/src/Tizen.NUI/src/public/PinchGestureDetector.cs index 719e6fc..133164f 100755 --- a/src/Tizen.NUI/src/public/PinchGestureDetector.cs +++ b/src/Tizen.NUI/src/public/PinchGestureDetector.cs @@ -63,7 +63,7 @@ namespace Tizen.NUI //Release your own unmanaged resources here. //You should not access any managed member here except static instance. - //because the execution order of Finalizes is non-deterministic. + //Because the execution order of Finalizes is non-deterministic. if (swigCPtr.Handle != global::System.IntPtr.Zero) @@ -172,13 +172,13 @@ namespace Tizen.NUI { DetectedEventArgs e = new DetectedEventArgs(); - // Populate all members of "e" (DetectedEventArgs) with real data + // Populate all members of "e" (DetectedEventArgs) with real data. e.View = Registry.GetManagedBaseHandleFromNativePtr(actor) as View; e.PinchGesture = Tizen.NUI.PinchGesture.GetPinchGestureFromPtr(pinchGesture); if (_pinchGestureEventHandler != null) { - //here we send all data to user event handlers + //Here we send all data to user event handlers. _pinchGestureEventHandler(this, e); } diff --git a/src/Tizen.NUI/src/public/PixelBuffer.cs b/src/Tizen.NUI/src/public/PixelBuffer.cs index 6b5942c..79d977a 100755 --- a/src/Tizen.NUI/src/public/PixelBuffer.cs +++ b/src/Tizen.NUI/src/public/PixelBuffer.cs @@ -21,18 +21,18 @@ namespace Tizen.NUI /// /// The PixelBuffer object holds a pixel buffer. - /// The PixelBuffer keeps ownership of it's initial buffer however, the - /// user is free to modify the pixel data, either directly, or via image operations. + /// The PixelBuffer keeps ownership of its initial buffer. However, the + /// user is free to modify the pixel data, either directly or via image operations. /// - /// In order to upload the pixel data to texture memory, there are two - /// possibilities - either convert it back to a PixelData object, which + /// In order to upload the pixel data to the texture memory, there are two + /// possibilities, either convert it back to a PixelData object, which /// releases the PixelBuffer object, leaving the user with an empty handle - /// (ideal for one-time indirect image manipulation), or create a new + /// (ideal for one-time indirect image manipulation) or create a new /// PixelData object from this object, leaving the buffer intact (ideal - /// for continuous manipulation) + /// for continuous manipulation). /// /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public class PixelBuffer : BaseHandle { @@ -61,7 +61,7 @@ namespace Tizen.NUI if (type == DisposeTypes.Explicit) { - //Called by User + //Called by User. //Release your own managed resources here. //You should release all of your own disposable objects here. @@ -69,7 +69,7 @@ namespace Tizen.NUI //Release your own unmanaged resources here. //You should not access any managed member here except static instance. - //because the execution order of Finalizes is non-deterministic. + //Because the execution order of Finalizes is non-deterministic. if (swigCPtr.Handle != global::System.IntPtr.Zero) { if (swigCMemOwn) @@ -84,13 +84,13 @@ namespace Tizen.NUI } /// - /// Create a PixelBuffer with it's own data buffer. + /// Create a PixelBuffer with its own data buffer. /// - /// The pixel buffer width - /// The pixel buffer height - /// The pixel format + /// The pixel buffer width. + /// The pixel buffer height. + /// The pixel format. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public PixelBuffer(uint width, uint height, PixelFormat pixelFormat) : this(NDalicPINVOKE.PixelBuffer_New(width, height, (int)pixelFormat), true) { @@ -110,15 +110,15 @@ namespace Tizen.NUI } /// - /// Convert to a pixel data and release the pixelBuffer's object. + /// Convert to a pixel data and release the object of the pixelBuffer. /// This handle is left empty. /// Any other handles that keep a reference to this object - /// will be left with no buffer, trying to access it will return NULL. + /// will be left with no buffer. Trying to access it will return NULL. /// - /// A pixel buffer - /// A new PixelData which takes ownership of the PixelBuffer's buffer. + /// A pixel buffer. + /// A new PixelData that takes ownership of the buffer of the pixelBuffer. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public static PixelData Convert(PixelBuffer pixelBuffer) { @@ -133,7 +133,7 @@ namespace Tizen.NUI /// /// The pixel data. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public PixelData CreatePixelData() { @@ -155,7 +155,7 @@ namespace Tizen.NUI /// /// The width of the buffer in pixels. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public uint GetWidth() { @@ -169,7 +169,7 @@ namespace Tizen.NUI /// /// The height of the buffer in pixels. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public uint GetHeight() { @@ -183,7 +183,7 @@ namespace Tizen.NUI /// /// The pixel format. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public PixelFormat GetPixelFormat() { @@ -193,21 +193,21 @@ namespace Tizen.NUI } /// - /// Apply the mask to this pixel data, and return a new pixel data containing - /// the masked image. If this PixelBuffer doesn't have an alpha channel, then + /// Apply the mask to this pixel data and return a new pixel data that contains + /// the masked image. If this PixelBuffer does not have an alpha channel, then /// the resultant PixelBuffer will be converted to a format that supports at /// least the width of the color channels and the alpha channel from the mask. /// - /// If cropToMask is set to true, then the contentScale is applied first to + /// If cropToMask is set to true, then the contentScale is applied first to /// this buffer, and the target buffer is cropped to the size of the mask. If - /// it's set to false, then the mask is scaled to match this buffer's size + /// it is set to false, then the mask is scaled to match the size of this buffer /// before the mask is applied. /// /// The mask to apply. /// The scaling factor to apply to the content. /// Whether to crop the output to the mask size (true) or scale the mask to the content size (false). /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public void ApplyMask(PixelBuffer mask, float contentScale, bool cropToMask) { @@ -216,20 +216,20 @@ namespace Tizen.NUI } /// - /// Apply the mask to this pixel data, and return a new pixel data containing - /// the masked image. If this PixelBuffer doesn't have an alpha channel, then + /// Apply the mask to this pixel data and return a new pixel data containing + /// the masked image. If this PixelBuffer does not have an alpha channel, then /// the resultant PixelBuffer will be converted to a format that supports at /// least the width of the color channels and the alpha channel from the mask. /// - /// If cropToMask is set to true, then the contentScale is applied first to + /// If cropToMask is set to true, then the contentScale is applied first to /// this buffer, and the target buffer is cropped to the size of the mask. If - /// it's set to false, then the mask is scaled to match this buffer's size + /// it is set to false, then the mask is scaled to match the size of this buffer /// before the mask is applied. /// /// The mask to apply. /// The scaling factor to apply to the content. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public void ApplyMask(PixelBuffer mask, float contentScale) { @@ -238,19 +238,19 @@ namespace Tizen.NUI } /// - /// Apply the mask to this pixel data, and return a new pixel data containing - /// the masked image. If this PixelBuffer doesn't have an alpha channel, then + /// Apply the mask to this pixel data and return a new pixel data containing + /// the masked image. If this PixelBuffer does not have an alpha channel, then /// the resultant PixelBuffer will be converted to a format that supports at /// least the width of the color channels and the alpha channel from the mask. /// - /// If cropToMask is set to true, then the contentScale is applied first to + /// If cropToMask is set to true, then the contentScale is applied first to /// this buffer, and the target buffer is cropped to the size of the mask. If - /// it's set to false, then the mask is scaled to match this buffer's size + /// it is set to false, then the mask is scaled to match the size of this buffer /// before the mask is applied. /// /// The mask to apply. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public void ApplyMask(PixelBuffer mask) { @@ -264,7 +264,7 @@ namespace Tizen.NUI /// /// The radius for Gaussian blur. A value of 0 or negative value indicates no blur. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public void ApplyGaussianBlur(float blurRadius) { @@ -280,7 +280,7 @@ namespace Tizen.NUI /// The crop width. /// The crop height. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public void Crop(ushort x, ushort y, ushort width, ushort height) { @@ -294,7 +294,7 @@ namespace Tizen.NUI /// The new width. /// The new height. /// 5 - /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API. [EditorBrowsable(EditorBrowsableState.Never)] public void Resize(ushort width, ushort height) { diff --git a/src/Tizen.NUI/src/public/PixelData.cs b/src/Tizen.NUI/src/public/PixelData.cs index 9754a3c..b5c776e 100755 --- a/src/Tizen.NUI/src/public/PixelData.cs +++ b/src/Tizen.NUI/src/public/PixelData.cs @@ -21,7 +21,7 @@ namespace Tizen.NUI /// /// The PixelData object holds a pixel buffer.
/// The PixelData takes over the ownership of the pixel buffer.
- /// The buffer memory must NOT be released outside of this class, instead, + /// The buffer memory must not be released outside of this class, instead, /// the PixelData object will release it automatically when the reference count falls to zero. /// /// Please DO NOT use! This will be deprecated! @@ -59,7 +59,7 @@ namespace Tizen.NUI if (type == DisposeTypes.Explicit) { - //Called by User + //Called by User. //Release your own managed resources here. //You should release all of your own disposable objects here. @@ -67,7 +67,7 @@ namespace Tizen.NUI //Release your own unmanaged resources here. //You should not access any managed member here except static instance. - //because the execution order of Finalizes is non-deterministic. + //Because the execution order of Finalizes is non-deterministic. if (swigCPtr.Handle != global::System.IntPtr.Zero) @@ -144,7 +144,7 @@ namespace Tizen.NUI } /// - /// Enumeration for Function to release the pixel buffer. + /// Enumeration for function to release the pixel buffer. /// /// 5 /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. diff --git a/src/Tizen.NUI/src/public/Property.cs b/src/Tizen.NUI/src/public/Property.cs index d8f381d..dd9c2de 100755 --- a/src/Tizen.NUI/src/public/Property.cs +++ b/src/Tizen.NUI/src/public/Property.cs @@ -1792,7 +1792,7 @@ namespace Tizen.NUI } /// - /// Retrieves a Rotation value. + /// Retrieves a rotation value. /// /// On return, a rotation value. /// Returns true if the value is successfully retrieved, false if the type is not convertible. diff --git a/src/Tizen.NUI/src/public/StyleManager.cs b/src/Tizen.NUI/src/public/StyleManager.cs index 4e57e16..49580b9 100644 --- a/src/Tizen.NUI/src/public/StyleManager.cs +++ b/src/Tizen.NUI/src/public/StyleManager.cs @@ -140,13 +140,13 @@ namespace Tizen.NUI { StyleChangedEventArgs e = new StyleChangedEventArgs(); - // Populate all members of "e" (StyleChangedEventArgs) with real data + // Populate all members of "e" (StyleChangedEventArgs) with real data. e.StyleManager = Registry.GetManagedBaseHandleFromNativePtr(styleManager) as StyleManager; e.StyleChange = styleChange; if (_styleManagerStyleChangedEventHandler != null) { - //here we send all data to user event handlers + //Here we send all data to user event handlers. _styleManagerStyleChangedEventHandler(this, e); } } diff --git a/src/Tizen.NUI/src/public/TapGestureDetector.cs b/src/Tizen.NUI/src/public/TapGestureDetector.cs index f4c85d5..460cf20 100755 --- a/src/Tizen.NUI/src/public/TapGestureDetector.cs +++ b/src/Tizen.NUI/src/public/TapGestureDetector.cs @@ -81,7 +81,7 @@ namespace Tizen.NUI } /// - /// Event arguments that passed via the TapGestureEvent signal. + /// Event arguments that are passed via the TapGestureEvent signal. /// /// 5 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. diff --git a/src/Tizen.NUI/src/public/Touch.cs b/src/Tizen.NUI/src/public/Touch.cs index e2fa49c..8944ea9 100755 --- a/src/Tizen.NUI/src/public/Touch.cs +++ b/src/Tizen.NUI/src/public/Touch.cs @@ -263,9 +263,9 @@ namespace Tizen.NUI } /// - /// Get mouse device's button value (ex: right/left button) + /// Get mouse device's button value (for example, right or left button) /// - /// The point required + /// The point required. /// /// 5 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. @@ -280,7 +280,7 @@ namespace Tizen.NUI } /// - /// Mouse device button type + /// Mouse device button type. /// /// 5 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. @@ -288,22 +288,22 @@ namespace Tizen.NUI public enum MouseButton { /// - /// No mouse button event or invalid data + /// No mouse button event or invalid data. /// /// 5 Invalid = -1, /// - /// Primary(Left) mouse button + /// Primary(Left) mouse button. /// /// 5 Primary = 1, /// - /// Secondary(Right) mouse button + /// Secondary(Right) mouse button. /// /// 5 Secondary = 3, /// - /// Center(Wheel) mouse button + /// Center(Wheel) mouse button. /// /// 5 Tertiary = 2, diff --git a/src/Tizen.NUI/src/public/VisualMaps.cs b/src/Tizen.NUI/src/public/VisualMaps.cs index da62412..b16e752 100755 --- a/src/Tizen.NUI/src/public/VisualMaps.cs +++ b/src/Tizen.NUI/src/public/VisualMaps.cs @@ -614,7 +614,7 @@ namespace Tizen.NUI /// /// The fitting mode of the visual. - /// The default is defined by the type of visual (if it's suitable to be stretched or not). + /// The default is defined by the type of visual (if it is suitable to be stretched or not). /// /// 5 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. @@ -701,7 +701,7 @@ namespace Tizen.NUI } /// - /// Overlays the auxiliary iamge on top of an NPatch image. + /// Overlays the auxiliary image on top of an NPatch image. /// The resulting visual image will be at least as large as the smallest possible n-patch or the auxiliary image, whichever is larger. /// /// 5 @@ -955,8 +955,8 @@ namespace Tizen.NUI } /// - /// Get or set the Image Visual release policy
- /// It decides if a texture should be released from the cache or kept to reduce loading time
+ /// Gets or sets the Image Visual release policy.
+ /// It decides if a texture should be released from the cache or kept to reduce the loading time.
/// /// 5 public ReleasePolicyType ReleasePolicy @@ -974,8 +974,8 @@ namespace Tizen.NUI /// - /// Get or set the Image Visual image loading policy
- /// It decides if a texture should be loaded immediately after source set or only after visual is added to window
+ /// Gets or sets the Image Visual image loading policy.
+ /// It decides if a texture should be loaded immediately after source set or only after the visual is added to the window.
/// /// 5 public LoadPolicyType LoadPolicy @@ -992,7 +992,7 @@ namespace Tizen.NUI } /// - /// Get or set whether to automatically correct the orientation based on exif data.
+ /// Gets or sets whether to automatically correct the orientation based on the Exchangeable Image File (EXIF) data.
/// If not specified, the default is true.
/// For JPEG images only.
/// Optional. @@ -1012,7 +1012,7 @@ namespace Tizen.NUI } /// - /// Whether to use the texture atlas. + /// Whether to use the texture atlas or not. /// Optional. By default atlasing is off. /// /// 5 @@ -1346,7 +1346,7 @@ namespace Tizen.NUI } /// - /// Gets or sets the Underline parameters. + /// Gets or sets the underline parameters. /// /// 5 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. @@ -1365,7 +1365,7 @@ namespace Tizen.NUI } /// - /// Gets or sets the Outline parameters. + /// Gets or sets the outline parameters. /// /// 5 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. @@ -1384,7 +1384,7 @@ namespace Tizen.NUI } /// - /// Gets or sets the Background parameters. + /// Gets or sets the background parameters. /// /// 5 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. @@ -1564,7 +1564,7 @@ namespace Tizen.NUI /// /// Gets or sets whether to render if the MixColor is transparent. - /// By default it's false, i.e. ColorVisual will not render if the MIX_COLOR is transparent. + /// By default it is false, which means that the ColorVisual will not render if the MIX_COLOR is transparent. /// /// 5 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API. @@ -2563,8 +2563,8 @@ namespace Tizen.NUI } /// - /// Gets and Sets the number of times the AnimatedImageVisual will be looped. - /// Default -1. if less than 0, loop unlimited. else, loop loopCount times. + /// Gets and sets the number of times the AnimatedImageVisual will be looped. + /// The default is -1. If the number is less than 0 then it loops unlimited,otherwise loop loopCount times. /// /// 5 public float LoopCount diff --git a/src/Tizen.NUI/src/public/Window.cs b/src/Tizen.NUI/src/public/Window.cs index 288407f..8927c14 100755 --- a/src/Tizen.NUI/src/public/Window.cs +++ b/src/Tizen.NUI/src/public/Window.cs @@ -926,10 +926,10 @@ namespace Tizen.NUI } /// - /// Sets keyboard repeat information. + /// Sets the keyboard repeat information. /// - /// The key repeat rate value in seconds - /// The key repeat delay value in seconds + /// The key repeat rate value in seconds. + /// The key repeat delay value in seconds. /// True if setting the keyboard repeat succeeds. /// 5 public bool SetKeyboardRepeatInfo(float rate, float delay) @@ -940,10 +940,10 @@ namespace Tizen.NUI } /// - /// Gets keyboard repeat information. + /// Gets the keyboard repeat information. /// - /// The key repeat rate value in seconds - /// The key repeat delay value in seconds + /// The key repeat rate value in seconds. + /// The key repeat delay value in seconds. /// True if setting the keyboard repeat succeeds. /// 5 public bool GetKeyboardRepeatInfo(out float rate, out float delay) @@ -1498,7 +1498,7 @@ namespace Tizen.NUI /// /// Sets whether the window is transparent or not. /// - /// Whether the window is transparent. + /// Whether the window is transparent or not. /// 5 public void SetTransparency(bool transparent) { NDalicManualPINVOKE.SetTransparency(swigCPtr, transparent); @@ -1694,7 +1694,7 @@ namespace Tizen.NUI } /// - /// Feed a key-event into the window. + /// Feeds a key event into the window. /// /// The key event to feed. /// 5 -- 2.7.4