[NUI] Update attribute and comments of PixelData 00/164600/2
authorxb.teng <xb.teng@samsung.com>
Wed, 20 Dec 2017 02:20:33 +0000 (10:20 +0800)
committerxb.teng <xb.teng@samsung.com>
Wed, 20 Dec 2017 02:46:31 +0000 (10:46 +0800)
Change-Id: If61c84887ba06394f653fc271e97d9fe091d6a90

src/Tizen.NUI/src/public/PixelData.cs

index 33c58b5..9754a3c 100755 (executable)
@@ -14,8 +14,6 @@
  * limitations under the License.
  *
  */
-
-using System;
 using System.ComponentModel;
 
 namespace Tizen.NUI
@@ -31,8 +29,8 @@ namespace Tizen.NUI
     /// And this would make some problem, because dotnet runtime would change the address of memory allocated.
     /// So this is required to be removed.
     /// currently no use. will be added later
-    /// <since_tizen> 3 </since_tizen>
-    [Obsolete("Please do not use! This will be deprecated!")]
+    /// <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 class PixelData : BaseHandle
     {
@@ -51,7 +49,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Dispose.
         /// </summary>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         protected override void Dispose(DisposeTypes type)
         {
             if (disposed)
@@ -94,7 +92,9 @@ namespace Tizen.NUI
         /// <param name="height">Buffer height in pixels.</param>
         /// <param name="pixelFormat">The pixel format.</param>
         /// <param name="releaseFunction">The function used to release the memory.</param>
-        /// <since_tizen> 3 </since_tizen>
+        /// <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 PixelData(byte[] buffer, uint bufferSize, uint width, uint height, PixelFormat pixelFormat, PixelData.ReleaseFunction releaseFunction) : this(NDalicPINVOKE.PixelData_New(buffer, bufferSize, width, height, (int)pixelFormat, (int)releaseFunction), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
@@ -105,7 +105,9 @@ namespace Tizen.NUI
         /// Gets the width of the buffer in pixels.
         /// </summary>
         /// <returns>The width of the buffer in pixels.</returns>
-        /// <since_tizen> 3 </since_tizen>
+        /// <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 uint GetWidth()
         {
             uint ret = NDalicPINVOKE.PixelData_GetWidth(swigCPtr);
@@ -117,7 +119,9 @@ namespace Tizen.NUI
         /// Gets the height of the buffer in pixels.
         /// </summary>
         /// <returns>The height of the buffer in pixels.</returns>
-        /// <since_tizen> 3 </since_tizen>
+        /// <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 uint GetHeight()
         {
             uint ret = NDalicPINVOKE.PixelData_GetHeight(swigCPtr);
@@ -129,7 +133,9 @@ namespace Tizen.NUI
         /// Gets the pixel format.
         /// </summary>
         /// <returns>The pixel format.</returns>
-        /// <since_tizen> 3 </since_tizen>
+        /// <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 PixelFormat GetPixelFormat()
         {
             PixelFormat ret = (PixelFormat)NDalicPINVOKE.PixelData_GetPixelFormat(swigCPtr);
@@ -140,20 +146,20 @@ namespace Tizen.NUI
         /// <summary>
         /// Enumeration for Function to release the pixel buffer.
         /// </summary>
-        /// <since_tizen> 3 </since_tizen>
+        /// <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 enum ReleaseFunction
         {
             /// <summary>
             /// Use free function to release the pixel buffer.
             /// </summary>
-            FREE,
+            Free,
 
             /// <summary>
             /// Use delete[] operator to release the pixel buffer.
             /// </summary>
-            DELETE_ARRAY
+            DeleteArray
         }
-
     }
-
 }
\ No newline at end of file