[ACR-564] deprecate unused API
[platform/core/csapi/tizenfx.git] / src / ElmSharp / ElmSharp / Point.cs
old mode 100755 (executable)
new mode 100644 (file)
index 3fe04cd..c2494fb
@@ -19,25 +19,43 @@ using System;
 namespace ElmSharp
 {
     /// <summary>
-    /// The Point is a struct that defines a 2-D point as a pair of generic type.
+    /// The Point is a struct that defines the 2D point as a pair of generic type.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public struct Point : IEquatable<Point>
     {
         /// <summary>
         /// Location along the horizontal axis.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public int X;
 
         /// <summary>
         /// Location along the vertical axis.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public int Y;
 
+        /// <summary>
+        /// A human readable representation of <see cref="Point"/>.
+        /// </summary>
+        /// <returns>The string is formatted as "{{X={0} Y={1}}}".</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public override string ToString()
         {
             return string.Format("{{X={0} Y={1}}}", X, Y);
         }
 
+        /// <summary>
+        /// Gets the hash code.
+        /// </summary>
+        /// <returns>The hash code.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public override int GetHashCode()
         {
             unchecked
@@ -46,6 +64,16 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Indicates whether this instance and a specified object are equal.
+        /// </summary>
+        /// <param name="obj">The object to compare with the current instance.</param>
+        /// <returns>
+        /// true if the object and this instance are of the same type and represent the same value,
+        /// otherwise false.
+        /// </returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public override bool Equals(object obj)
         {
             if (!(obj is Point))
@@ -54,31 +82,45 @@ namespace ElmSharp
             return Equals((Point)obj);
         }
 
+        /// <summary>
+        /// Indicates whether this instance and a <see cref="Point"/> object are equal.
+        /// </summary>
+        /// <param name="other">The <see cref="Point"/> to compare with the current instance.</param>
+        /// <returns>
+        /// true if the object and this instance are the same type and represent the same value,
+        /// otherwise false.
+        /// </returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public bool Equals(Point other)
         {
             return X.Equals(other.X) && Y.Equals(other.Y);
         }
 
         /// <summary>
-        /// Whether the two <see cref="T:Tizen.UI.Point" />s are equal.
+        /// Whether both <see cref="Point"/>s are equal.
         /// </summary>
-        /// <param name="p1">A <see cref="T:Tizen.UI.Point" /> on the left hand side.</param>
-        /// <param name="p2">A <see cref="T:Tizen.UI.Point" /> on the right hand side.</param>
-        /// <returns>True if the two <see cref="T:Tizen.UI.Point" />s have equal values.</returns>
+        /// <param name="p1">A <see cref="Point"/> on the left hand side.</param>
+        /// <param name="p2">A <see cref="Point"/> on the right hand side.</param>
+        /// <returns>True if both <see cref="Point"/>s have equal values.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static bool operator ==(Point p1, Point p2)
         {
             return p1.Equals(p2);
         }
 
         /// <summary>
-        /// Whether two <see cref="T:Tizen.UI.Point" />s are not equal.
+        /// Whether both <see cref="Point"/>s are not equal.
         /// </summary>
-        /// <param name="p1">A <see cref="T:Tizen.UI.Point" /> on the left hand side.</param>
-        /// <param name="p2">A <see cref="T:Tizen.UI.Point" /> on the right hand side.</param>
-        /// <returns>True if the two <see cref="T:Tizen.UI.Point" />s do not have equal values.</returns>
+        /// <param name="p1">A <see cref="Point"/> on the left hand side.</param>
+        /// <param name="p2">A <see cref="Point"/> on the right hand side.</param>
+        /// <returns>True if both <see cref="Point"/>s do not have equal values.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static bool operator !=(Point p1, Point p2)
         {
             return !p1.Equals(p2);
         }
     }
-}
+}
\ No newline at end of file