From: dongsug.song Date: Thu, 9 Jun 2022 09:22:28 +0000 (+0900) Subject: [NUI] Fix comments according to the document review X-Git-Tag: submit/tizen_6.5/20220614.151059~1^2~3 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=900d4b7721213ffcc102fa1805dd397c69c30edb;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git [NUI] Fix comments according to the document review --- diff --git a/src/Tizen.NUI/src/internal/Common/Disposable.cs b/src/Tizen.NUI/src/internal/Common/Disposable.cs index a0a8720e0..26829d669 100644 --- a/src/Tizen.NUI/src/internal/Common/Disposable.cs +++ b/src/Tizen.NUI/src/internal/Common/Disposable.cs @@ -26,10 +26,10 @@ namespace Tizen.NUI public class Disposable : global::System.IDisposable { /// - /// A Flag to check if it is already disposed. + /// The flag to check if it is already disposed of. /// /// 6 - [Obsolete("Deprecated in API9, Will be removed in API11, Please use Disposed")] + [Obsolete("Deprecated in API9, will be removed in API11, Use Disposed")] [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "")] protected bool disposed = false; @@ -189,7 +189,7 @@ namespace Tizen.NUI internal bool SwigCMemOwn => swigCMemOwn; /// - /// A Flag to check if it is already disposed. + /// The flag to check if it is already disposed of. /// [EditorBrowsable(EditorBrowsableState.Never)] protected internal bool Disposed => disposed; diff --git a/src/Tizen.NUI/src/public/Animation/Animation.cs b/src/Tizen.NUI/src/public/Animation/Animation.cs index c3962724e..a8cbbbd5a 100755 --- a/src/Tizen.NUI/src/public/Animation/Animation.cs +++ b/src/Tizen.NUI/src/public/Animation/Animation.cs @@ -435,7 +435,7 @@ namespace Tizen.NUI /// /// Gets or sets the properties of the animation. /// - //ToDo : will raise deprecated-ACR, [Obsolete("Deprecated in API9, Will be removed in API11, Please use PropertyList instead")] + //ToDo : will raise deprecated-ACR, [Obsolete("Deprecated in API9, will be removed in API11, Use PropertyList instead")] [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "This API will be deprecated, so suppressing the warning for now")] public string[] Properties { @@ -452,7 +452,7 @@ namespace Tizen.NUI /// /// Gets or sets the destination value for each property of the animation. /// - //ToDo : will raise deprecated-ACR, [Obsolete("Deprecated in API9, Will be removed in API11, Please use DestValueList instead")] + //ToDo : will raise deprecated-ACR, [Obsolete("Deprecated in API9, will be removed in API11, Use DestValueList instead")] [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "This API will be deprecated, so suppressing the warning for now")] public string[] DestValue { @@ -469,7 +469,7 @@ namespace Tizen.NUI /// /// Gets or sets the start time for each property of the animation. /// - //ToDo : will raise deprecated-ACR, [Obsolete("Deprecated in API9, Will be removed in API11, Please use StartTimeList instead")] + //ToDo : will raise deprecated-ACR, [Obsolete("Deprecated in API9, will be removed in API11, Use StartTimeList instead")] [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "This API will be deprecated, so suppressing the warning for now")] public int[] StartTime { @@ -486,7 +486,7 @@ namespace Tizen.NUI /// /// Gets or sets the end time for each property of the animation. /// - //ToDo : will raise deprecated-ACR, [Obsolete("Deprecated in API9, Will be removed in API11, Please use EndTimeList instead")] + //ToDo : will raise deprecated-ACR, [Obsolete("Deprecated in API9, will be removed in API11, Use EndTimeList instead")] [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "This API will be deprecated, so suppressing the warning for now")] public int[] EndTime { diff --git a/src/Tizen.NUI/src/public/Common/BaseHandle.cs b/src/Tizen.NUI/src/public/Common/BaseHandle.cs index 909138ae0..8a03c561a 100755 --- a/src/Tizen.NUI/src/public/Common/BaseHandle.cs +++ b/src/Tizen.NUI/src/public/Common/BaseHandle.cs @@ -31,15 +31,15 @@ namespace Tizen.NUI /// swigCMemOwn /// /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11, Please use SwigCMemOwn")] + [Obsolete("Deprecated in API9, will be removed in API11, Use SwigCMemOwn")] [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "")] protected bool swigCMemOwn; /// - /// A flag to check if it is already disposed. + /// The flag to check if it is already disposed of. /// /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11, Please use Disposed")] + [Obsolete("Deprecated in API9, will be removed in API11, Use Disposed")] [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "")] protected bool disposed = false; @@ -47,7 +47,7 @@ namespace Tizen.NUI private global::System.Runtime.InteropServices.HandleRef swigCPtrCopy; private bool registerMe; - //A Flag to check who called Dispose(). (By User or DisposeQueue) + //The flag to check who called Dispose(). (By User or DisposeQueue) private bool isDisposeQueued = false; /// @@ -117,7 +117,7 @@ namespace Tizen.NUI /// /// 5 /// - [Obsolete("Deprecated in API9, Will be removed in API11, Please use BindableObject.PropertyChanged instead!")] + [Obsolete("Deprecated in API9, will be removed in API11, Use BindableObject.PropertyChanged instead!")] public event PropertyChangedEventHandler PropertySet; internal global::System.Runtime.InteropServices.HandleRef GetBaseHandleCPtrHandleRef @@ -593,13 +593,13 @@ namespace Tizen.NUI protected internal bool SwigCMemOwn => swigCMemOwn; /// - /// A flag to check if it is already disposed. + /// The flag to check if it is already disposed of. /// [EditorBrowsable(EditorBrowsableState.Never)] protected internal bool Disposed => disposed; /// - /// A flag to check if it is disposed by DisposeQueue. + /// The flag to check if it is disposed by DisposeQueue. /// [EditorBrowsable(EditorBrowsableState.Never)] protected internal bool IsDisposeQueued => isDisposeQueued; diff --git a/src/Tizen.NUI/src/public/Common/StyleManager.cs b/src/Tizen.NUI/src/public/Common/StyleManager.cs index 5e68aa720..f21eeb134 100755 --- a/src/Tizen.NUI/src/public/Common/StyleManager.cs +++ b/src/Tizen.NUI/src/public/Common/StyleManager.cs @@ -30,7 +30,7 @@ namespace Tizen.NUI /// It provides the path to the application resource root folder, from there the filename can be specified along with any subfolders, for example, Images, Models, etc.
/// /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11. Please use ThemeManager instead.")] + [Obsolete("Deprecated in API9, will be removed in API11. Use ThemeManager instead.")] public class StyleManager : BaseHandle { private static readonly StyleManager instance = StyleManager.Get(); @@ -42,7 +42,7 @@ namespace Tizen.NUI /// This can be initialized with StyleManager::Get().
/// /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11. Please use ThemeManager instead.")] + [Obsolete("Deprecated in API9, will be removed in API11. Use ThemeManager instead.")] public StyleManager() : this(Interop.StyleManager.NewStyleManager(), true) { if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve(); @@ -58,7 +58,7 @@ namespace Tizen.NUI /// and the controls have been informed.
/// /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11. Please use ThemeManager instead.")] + [Obsolete("Deprecated in API9, will be removed in API11. Use ThemeManager instead.")] public event EventHandler StyleChanged { add @@ -84,7 +84,7 @@ namespace Tizen.NUI /// Gets the singleton of the StyleManager object. /// /// 5 - [Obsolete("Deprecated in API9, Will be removed in API11. Please use ThemeManager instead.")] + [Obsolete("Deprecated in API9, will be removed in API11. Use ThemeManager instead.")] public static StyleManager Instance { get @@ -98,7 +98,7 @@ namespace Tizen.NUI /// /// A handle to the StyleManager control. /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11. Please use ThemeManager instead.")] + [Obsolete("Deprecated in API9, will be removed in API11. Use ThemeManager instead.")] public static StyleManager Get() { StyleManager ret = new StyleManager(Interop.StyleManager.Get(), true); @@ -115,7 +115,7 @@ namespace Tizen.NUI /// /// A relative path is specified for style theme. /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11. Please use ThemeManager instead.")] + [Obsolete("Deprecated in API9, will be removed in API11. Use ThemeManager instead.")] public void ApplyTheme(string themeFile) { Interop.StyleManager.ApplyTheme(SwigCPtr, themeFile); @@ -126,7 +126,7 @@ namespace Tizen.NUI /// Applies the default Toolkit theme. /// /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11. Please use ThemeManager instead.")] + [Obsolete("Deprecated in API9, will be removed in API11. Use ThemeManager instead.")] public void ApplyDefaultTheme() { Interop.StyleManager.ApplyDefaultTheme(SwigCPtr); @@ -139,7 +139,7 @@ namespace Tizen.NUI /// The key of the constant. /// The value of the constant. /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11. Please use ThemeManager instead.")] + [Obsolete("Deprecated in API9, will be removed in API11. Use ThemeManager instead.")] public void AddConstant(string key, PropertyValue value) { Interop.StyleManager.SetStyleConstant(SwigCPtr, key, PropertyValue.getCPtr(value)); @@ -153,7 +153,7 @@ namespace Tizen.NUI /// The value of the constant if it exists. /// /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11. Please use ThemeManager instead.")] + [Obsolete("Deprecated in API9, will be removed in API11. Use ThemeManager instead.")] public bool GetConstant(string key, PropertyValue valueOut) { bool ret = Interop.StyleManager.GetStyleConstant(SwigCPtr, key, PropertyValue.getCPtr(valueOut)); @@ -168,7 +168,7 @@ namespace Tizen.NUI /// The name of the JSON style file to apply. /// The name of the style within the JSON file to apply. /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11. Please use ThemeManager instead.")] + [Obsolete("Deprecated in API9, will be removed in API11. Use ThemeManager instead.")] public void ApplyStyle(View control, string jsonFileName, string styleName) { Interop.StyleManager.ApplyStyle(SwigCPtr, View.getCPtr(control), jsonFileName, styleName); @@ -242,7 +242,7 @@ namespace Tizen.NUI /// Style changed event arguments. /// /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11. Please use ThemeManager instead.")] + [Obsolete("Deprecated in API9, will be removed in API11. Use ThemeManager instead.")] public class StyleChangedEventArgs : EventArgs { private StyleManager styleManager; @@ -252,7 +252,7 @@ namespace Tizen.NUI /// StyleManager. /// /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11. Please use ThemeManager instead.")] + [Obsolete("Deprecated in API9, will be removed in API11. Use ThemeManager instead.")] public StyleManager StyleManager { get @@ -270,7 +270,7 @@ namespace Tizen.NUI /// default font size changed or theme has changed).
/// /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11. Please use ThemeManager instead.")] + [Obsolete("Deprecated in API9, will be removed in API11. Use ThemeManager instead.")] public StyleChangeType StyleChange { get diff --git a/src/Tizen.NUI/src/public/CustomView/CustomViewRegistry.cs b/src/Tizen.NUI/src/public/CustomView/CustomViewRegistry.cs index b37ede284..8d5029700 100755 --- a/src/Tizen.NUI/src/public/CustomView/CustomViewRegistry.cs +++ b/src/Tizen.NUI/src/public/CustomView/CustomViewRegistry.cs @@ -93,7 +93,7 @@ namespace Tizen.NUI public class ScriptableProperty : System.Attribute { /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11, Please use Type")] + [Obsolete("Deprecated in API9, will be removed in API11, Use Type")] [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "")] public readonly ScriptableType type; @@ -118,7 +118,7 @@ namespace Tizen.NUI } /// - /// ScriptableType. Read Writable, non-animatable property, event thread only. + /// ScriptableType: Read Writable, non-animatable property, event thread only. /// [EditorBrowsable(EditorBrowsableState.Never)] public ScriptableType Type => type; diff --git a/src/Tizen.NUI/src/public/Input/InputMethodContext.cs b/src/Tizen.NUI/src/public/Input/InputMethodContext.cs index a7352d5d8..d8f937e71 100755 --- a/src/Tizen.NUI/src/public/Input/InputMethodContext.cs +++ b/src/Tizen.NUI/src/public/Input/InputMethodContext.cs @@ -943,7 +943,7 @@ namespace Tizen.NUI /// The state if it owns memory /// /// 5 - [Obsolete("This has been deprecated in API9 and will be removed in API11. Please use swigCMemOwn which is declared in parent class")] + [Obsolete("This has been deprecated in API9 and will be removed in API11. Use swigCMemOwn which is declared in parent class")] [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "")] protected bool swigCMemOwn; private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -1103,7 +1103,7 @@ namespace Tizen.NUI /// The state if it owns memory /// /// 5 - [Obsolete("This has been deprecated in API9 and will be removed in API11. Please use SwigCMemOwn which is declared in parent class")] + [Obsolete("This has been deprecated in API9 and will be removed in API11. Use SwigCMemOwn which is declared in parent class")] [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "")] protected bool swigCMemOwn; private global::System.Runtime.InteropServices.HandleRef swigCPtr; diff --git a/src/Tizen.NUI/src/public/Input/KeyValue.cs b/src/Tizen.NUI/src/public/Input/KeyValue.cs index 2ee1bb600..24cf408ea 100755 --- a/src/Tizen.NUI/src/public/Input/KeyValue.cs +++ b/src/Tizen.NUI/src/public/Input/KeyValue.cs @@ -32,7 +32,7 @@ namespace Tizen.NUI /// Int key. /// /// When deleting the field, change it to property. - [Obsolete("Deprecated in API9, Will be removed in API11. Please use IntegerKey instead.")] + [Obsolete("Deprecated in API9, will be removed in API11. Use IntegerKey instead.")] [SuppressMessage("Microsoft.Design", "CA1051:Do not declare visible instance fields")] public int? KeyInt = null; @@ -40,7 +40,7 @@ namespace Tizen.NUI /// String key. /// /// When deleting the field, change it to property. - [Obsolete("Deprecated in API9, Will be removed in API11. Please use StringKey instead.")] + [Obsolete("Deprecated in API9, will be removed in API11. Use StringKey instead.")] [SuppressMessage("Microsoft.Design", "CA1051:Do not declare visible instance fields")] public string KeyString = null; @@ -48,7 +48,7 @@ namespace Tizen.NUI /// True value. /// /// When deleting the field, change it to property. - [Obsolete("Deprecated in API9, Will be removed in API11. Please use PropertyValue instead.")] + [Obsolete("Deprecated in API9, will be removed in API11. Use PropertyValue instead.")] [SuppressMessage("Microsoft.Design", "CA1051:Do not declare visible instance fields")] public PropertyValue TrueValue = null; diff --git a/src/Tizen.NUI/src/public/Layouting/LayoutTransition.cs b/src/Tizen.NUI/src/public/Layouting/LayoutTransition.cs index 56afadb1e..70dd5ad7f 100755 --- a/src/Tizen.NUI/src/public/Layouting/LayoutTransition.cs +++ b/src/Tizen.NUI/src/public/Layouting/LayoutTransition.cs @@ -137,7 +137,7 @@ namespace Tizen.NUI /// /// 6 /// When deleting the field, change it to property. - [Obsolete("Deprecated in API9, Will be removed in API11. Please use GetDuration, SetDuration instead!")] + [Obsolete("Deprecated in API9, will be removed in API11. Use GetDuration, SetDuration instead!")] [SuppressMessage("Microsoft.Design", "CA1051:Do not declare visible instance fields")] public int Duration; @@ -146,7 +146,7 @@ namespace Tizen.NUI /// /// 6 /// When deleting the field, change it to property. - [Obsolete("Deprecated in API9, Will be removed in API11. Please use GetDelay, SetDelay instead!")] + [Obsolete("Deprecated in API9, will be removed in API11. Use GetDelay, SetDelay instead!")] [SuppressMessage("Microsoft.Design", "CA1051:Do not declare visible instance fields")] public int Delay; @@ -154,7 +154,7 @@ namespace Tizen.NUI /// Get, Set the function to alter the transition path over time. /// /// 6 - [Obsolete("Deprecated in API9, Will be removed in API11. Please use GetAlphaFunction, SetAlphaFunction instead!")] + [Obsolete("Deprecated in API9, will be removed in API11. Use GetAlphaFunction, SetAlphaFunction instead!")] [SuppressMessage("Microsoft.Design", "CA1051:Do not declare visible instance fields")] public AlphaFunction AlphaFunction; diff --git a/src/Tizen.NUI/src/public/Layouting/MeasureSpecification.cs b/src/Tizen.NUI/src/public/Layouting/MeasureSpecification.cs index 9f0ebb52d..50e13e558 100755 --- a/src/Tizen.NUI/src/public/Layouting/MeasureSpecification.cs +++ b/src/Tizen.NUI/src/public/Layouting/MeasureSpecification.cs @@ -32,7 +32,7 @@ namespace Tizen.NUI /// /// 6 /// When deleting the field, change it to property. - [Obsolete("Deprecated in API9, Will be removed in API11. Please use GetSize,SetSize instead!")] + [Obsolete("Deprecated in API9, will be removed in API11. Use GetSize,SetSize instead!")] [SuppressMessage("Microsoft.Design", "CA1051:Do not declare visible instance fields")] public LayoutLength Size; @@ -41,7 +41,7 @@ namespace Tizen.NUI /// /// 6 /// When deleting the field, change it to property. - [Obsolete("Deprecated in API9, Will be removed in API11. Please use GetMode,SetMode instead!")] + [Obsolete("Deprecated in API9, will be removed in API11. Use GetMode,SetMode instead!")] [SuppressMessage("Microsoft.Design", "CA1051:Do not declare visible instance fields")] public MeasureSpecification.ModeType Mode; diff --git a/src/Tizen.NUI/src/public/Visuals/VisualMaps.cs b/src/Tizen.NUI/src/public/Visuals/VisualMaps.cs index 411ac71bc..5b8d5ff84 100755 --- a/src/Tizen.NUI/src/public/Visuals/VisualMaps.cs +++ b/src/Tizen.NUI/src/public/Visuals/VisualMaps.cs @@ -31,7 +31,7 @@ namespace Tizen.NUI /// outputVisualMap. /// /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11, Please use OutputVisualMap")] + [Obsolete("Deprecated in API9, will be removed in API11, Use OutputVisualMap")] [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "")] protected PropertyMap _outputVisualMap = null; @@ -39,7 +39,7 @@ namespace Tizen.NUI /// The shader of the visual. /// /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11, Please use Shader")] + [Obsolete("Deprecated in API9, will be removed in API11, Use Shader")] [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "")] protected PropertyMap _shader = null; //private PropertyMap _transform = null; @@ -48,7 +48,7 @@ namespace Tizen.NUI /// The premultipliedAlpha of the visual. /// /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11, Please use PremultipliedAlpha")] + [Obsolete("Deprecated in API9, will be removed in API11, Use PremultipliedAlpha")] [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "")] protected bool? _premultipliedAlpha = null; @@ -56,7 +56,7 @@ namespace Tizen.NUI /// The mixColor of the Visual. /// /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11, Please use MixColor")] + [Obsolete("Deprecated in API9, will be removed in API11, Use MixColor")] [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "")] protected Color _mixColor = null; @@ -64,7 +64,7 @@ namespace Tizen.NUI /// The opacity of the visual. /// /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11, Please use Opacity")] + [Obsolete("Deprecated in API9, will be removed in API11, Use Opacity")] [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "")] protected float? _opacity = null; @@ -72,7 +72,7 @@ namespace Tizen.NUI /// The FittingMode of the visual. /// /// 5 - [Obsolete("Deprecated in API9, Will be removed in API11, Please use VisualFittingMode")] + [Obsolete("Deprecated in API9, will be removed in API11, Use VisualFittingMode")] [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "")] protected VisualFittingModeType? _visualFittingMode = null; @@ -85,7 +85,7 @@ namespace Tizen.NUI /// The map for visual. /// /// 3 - [Obsolete("Deprecated in API9, Will be removed in API11, Please not use _comonlyUsedMap")] + [Obsolete("Deprecated in API9, will be removed in API11, Please not use _comonlyUsedMap")] [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1051:Do not declare visible instance fields", Justification = "")] protected PropertyMap _commonlyUsedMap = null;