[NUI] change some comments of Timer and Window APIs 27/163127/1 4.0.1-preview1-00038
authordongsug.song <dongsug.song@samsung.com>
Thu, 7 Dec 2017 09:26:33 +0000 (18:26 +0900)
committerdongsug.song <dongsug.song@samsung.com>
Thu, 7 Dec 2017 09:26:33 +0000 (18:26 +0900)
Change-Id: I46c9f3e7c100ec87ce52b1acf846d1c3f8573ce3
Signed-off-by: dongsug.song <dongsug.song@samsung.com>
src/Tizen.NUI/src/public/Timer.cs
src/Tizen.NUI/src/public/Window.cs

index 4f94681..cfae067 100755 (executable)
@@ -99,7 +99,7 @@ namespace Tizen.NUI
         }
 
         [UnmanagedFunctionPointer(CallingConvention.StdCall)]
-        private delegate bool TickCallbackDelegate(IntPtr data);
+        private delegate bool TickCallbackDelegate();
         private EventHandlerWithReturnType<object, TickEventArgs, bool> _timerTickEventHandler;
         private TickCallbackDelegate _timerTickCallbackDelegate;
 
@@ -114,7 +114,7 @@ namespace Tizen.NUI
             {
                 if (_timerTickEventHandler == null)
                 {
-                    _timerTickCallbackDelegate = new TickCallbackDelegate(OnTick);
+                    _timerTickCallbackDelegate = (OnTick);
                     TickSignal().Connect(_timerTickCallbackDelegate);
                 }
                 _timerTickEventHandler += value;
@@ -129,7 +129,7 @@ namespace Tizen.NUI
             }
         }
 
-        private bool OnTick(IntPtr data)
+        private bool OnTick()
         {
             TickEventArgs e = new TickEventArgs();
 
@@ -206,6 +206,9 @@ namespace Tizen.NUI
         /// <summary>
         /// Gets/Sets the interval of the timer.
         /// </summary>
+        /// <remarks>For setter, this sets a new interval on the timer and starts the timer. <br />
+        /// Cancels the previous timer.
+        /// </remarks>
         /// <since_tizen> 4 </since_tizen>
         public uint Interval
         {
index da329fa..e21644c 100755 (executable)
@@ -366,9 +366,14 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Sets a transparent window's visual state to opaque.
+        /// Sets a transparent window's visual state to opaque. <br />
+        /// If a visual state of a transparent window is opaque, <br />
+        /// then the window manager could handle it as an opaque window when calculating visibility.
         /// </summary>
         /// <param name="opaque">Whether the window's visual state is opaque.</param>
+        /// <remarks>This will have no effect on an opaque window. <br />
+        /// It doesn't change transparent window to opaque window but lets the window manager know the visual state of the window.
+        /// </remarks>
         /// <since_tizen> 3 </since_tizen>
         public void SetOpaqueState(bool opaque)
         {
@@ -380,6 +385,7 @@ namespace Tizen.NUI
         /// Returns whether a transparent window's visual state is opaque or not.
         /// </summary>
         /// <returns>True if the window's visual state is opaque, false otherwise.</returns>
+        /// <remarks> The return value has no meaning on an opaque window. </remarks>
         /// <since_tizen> 3 </since_tizen>
         public bool IsOpaqueState()
         {
@@ -1485,7 +1491,8 @@ namespace Tizen.NUI
         /// <since_tizen> 5 </since_tizen>
         /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
         [EditorBrowsable(EditorBrowsableState.Never)]
-        public void SetTransparency(bool transparent) {
+        public void SetTransparency(bool transparent)
+        {
             NDalicManualPINVOKE.SetTransparency(swigCPtr, transparent);
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
         }