[ACR-564] deprecate unused API

[platform/core/csapi/tizenfx.git] / src / ElmSharp / ElmSharp / Point3D.cs

diff --git a/src/ElmSharp/ElmSharp/Point3D.cs b/src/ElmSharp/ElmSharp/Point3D.cs
index 1ac96af..8aa06a9 100644 (file)
--- a/src/ElmSharp/ElmSharp/Point3D.cs
+++ b/src/ElmSharp/ElmSharp/Point3D.cs
@@ -19,38 +19,47 @@ using System;
 namespace ElmSharp
 {
     /// <summary>
-    /// Struct defining a 3-D point.
+    /// The Point3D is a struct that defines a 3D point.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public struct Point3D : IEquatable<Point3D>
     {
         /// <summary>
-        /// The X coordinate of a 3D point.
+        /// The X-coordinate of a 3D point.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public int X;
 
         /// <summary>
-        /// The Y coordinate of a 3D point.
+        /// The Y-coordinate of a 3D point.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public int Y;
 
         /// <summary>
-        /// The Z coordinate of a 3D point.
+        /// The Z-coordinate of a 3D point.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public int Z;
 
         /// <summary>
-        /// A human-readable representation of the <see cref="T:Tizen.UI.Point3D" />.
+        /// A human-readable representation of <see cref="Point3D"/>.
         /// </summary>
         /// <returns>The string is formatted as "{{X={0} Y={1} Z={2}}}".</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public override string ToString()
         {
             return string.Format("{{X={0} Y={1} Z={2}}}", X, Y, Z);
         }
 
-        /// <summary>
-        /// Returns a hash value for the <see cref="T:Tizen.UI.Point3D" />.
-        /// </summary>
-        /// <returns>A value intended for efficient insertion and lookup in hashtable-based data structures.</returns>
+        ///
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public override int GetHashCode()
         {
             unchecked
@@ -63,10 +72,15 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Returns true if the X, Y and Z values of this are exactly equal to those in the argument.
+        /// Indicates whether this instance and a specified object are equal.
         /// </summary>
-        /// <param name="obj">Another <see cref="T:Tizen.UI.Point3D" />.</param>
-        /// <returns>True if the X, Y and Z values are equal to those in <paramref name="obj" />. Returns false if <paramref name="obj" /> is not a <see cref="T:Tizen.UI.Point" />.</returns>
+        /// <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 Point3D))
@@ -76,35 +90,44 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Returns true if the X, Y and Z values of this are exactly equal to those in the argument.
+        /// Indicates whether this instance and a <see cref="Point3D"/> object are equal.
         /// </summary>
-        /// <param name="other">Another <see cref="T:Tizen.UI.Point3D" />.</param>
-        /// <returns>True if the X, Y and Z values are equal to those in <paramref name="other" />.</returns>
+        /// <param name="other">The <see cref="Point3D"/> 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 bool Equals(Point3D other)
         {
             return X.Equals(other.X) && Y.Equals(other.Y) && Z.Equals(other.Z);
         }
 
         /// <summary>
-        /// Whether the two <see cref="T:Tizen.UI.Point3D" />s are equal.
+        /// Whether both <see cref="Point3D"/>s are equal.
         /// </summary>
-        /// <param name="p1">A <see cref="T:Tizen.UI.Point3D" /> on the left hand side.</param>
-        /// <param name="p2">A <see cref="T:Tizen.UI.Point3D" /> on the right hand side.</param>
-        /// <returns>True if the two <see cref="T:Tizen.UI.Point3D" />s have equal values.</returns>
+        /// <param name="p1">A <see cref="Point3D"/> on the left hand side.</param>
+        /// <param name="p2">A <see cref="Point3D"/> on the right hand side.</param>
+        /// <returns>True if both <see cref="Point3D"/>s have equal values.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static bool operator ==(Point3D p1, Point3D p2)
         {
             return p1.Equals(p2);
         }
 
         /// <summary>
-        /// Whether two <see cref="T:Tizen.UI.Point3D" />s are not equal.
+        /// Whether both <see cref="Point3D"/>s are not equal.
         /// </summary>
-        /// <param name="p1">A <see cref="T:Tizen.UI.Point3D" /> on the left hand side.</param>
-        /// <param name="p2">A <see cref="T:Tizen.UI.Point3D" /> on the right hand side.</param>
-        /// <returns>True if the two <see cref="T:Tizen.UI.Point3D" />s do not have equal values.</returns>
+        /// <param name="p1">A <see cref="Point3D"/> on the left hand side.</param>
+        /// <param name="p2">A <see cref="Point3D"/> on the right hand side.</param>
+        /// <returns>True if both <see cref="Point3D"/>s do not have equal values.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static bool operator !=(Point3D p1, Point3D p2)
         {
             return !p1.Equals(p2);
         }
     }
-}
+}
\ No newline at end of file