[ACR-564] deprecate unused API
[platform/core/csapi/tizenfx.git] / src / ElmSharp.Wearable / ElmSharp.Wearable / RotaryEventManager.cs
index f413ae4..42949a7 100644 (file)
@@ -22,15 +22,19 @@ using System.Text;
 namespace ElmSharp.Wearable
 {
     /// <summary>
-    /// RotaryEventManager serve functions for global Rotary event like Galaxy Gear.
+    /// The RotaryEventManager serves functions for the global Rotary event like Galaxy Gear.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public static class RotaryEventManager
     {
         static Dictionary<RotaryEventHandler, Interop.Eext.Eext_Rotary_Handler_Cb> s_rotaryEventHandlers = new Dictionary<RotaryEventHandler, Interop.Eext.Eext_Rotary_Handler_Cb>();
 
         /// <summary>
-        /// Rotated will triggered when rotatable device like Galaxy Gear Bezel is rotated.
+        /// Rotated will be triggered when the rotatable device like the Galaxy Gear Bezel is rotated.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static event RotaryEventHandler Rotated
         {
             add
@@ -65,18 +69,22 @@ namespace ElmSharp.Wearable
 
 
     /// <summary>
-    /// RotaryEventManager serve extension functions for Rotary event to EvasObject on device like Galaxy Gear.
+    /// The RotaryEventManager serves extension functions for the Rotary event to EvasObject on a device like Galaxy Gear.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public static class RotaryEventExtensions
     {
         static Dictionary<EvasObject, RotaryEventHandler> s_rotaryObjectEventHandlers = new Dictionary<EvasObject, RotaryEventHandler>();
         static Dictionary<EvasObject, Interop.Eext.Eext_Rotary_Event_Cb> s_rotaryObjectEventMap = new Dictionary<EvasObject, Interop.Eext.Eext_Rotary_Event_Cb>();
 
         /// <summary>
-        /// Add a handler for Rotary event on specific EvasObject.
+        /// Adds a handler for the Rotary event on a specific EvasObject.
         /// </summary>
-        /// <param name="obj">Target EvasObject</param>
-        /// <param name="handler">Event handler for Rotary event</param>
+        /// <param name="obj">Target EvasObject.</param>
+        /// <param name="handler">Event handler for the Rotary event.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static void AddRotaryEventHandler(this EvasObject obj, RotaryEventHandler handler)
         {
             EnableRotaryEventHandler(obj);
@@ -92,10 +100,12 @@ namespace ElmSharp.Wearable
         }
 
         /// <summary>
-        /// Remove a handler on specific EvasObject for Rotary event.
+        /// Removes a handler on a specific EvasObject for the Rotary event.
         /// </summary>
-        /// <param name="obj">Target EvasObject</param>
-        /// <param name="handler">Event handler for Rotary event</param>
+        /// <param name="obj">Target EvasObject.</param>
+        /// <param name="handler">Event handler for Rotary event.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static void RemoveRotaryEventHandler(this EvasObject obj, RotaryEventHandler handler)
         {
             if (s_rotaryObjectEventHandlers.ContainsKey(obj))
@@ -110,36 +120,44 @@ namespace ElmSharp.Wearable
         }
 
         /// <summary>
-        /// Activate this circle widget can take Rotary event.
+        /// Activates this Circle widget that can take the Rotary event.
         /// </summary>
-        /// <param name="widget">Target circle widget</param>
+        /// <param name="widget">Target the Circle widget.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static void Activate(this IRotaryActionWidget widget)
         {
             Interop.Eext.eext_rotary_object_event_activated_set(widget.CircleHandle, true);
         }
 
         /// <summary>
-        /// Deactivate this circle widget is blocked from Rotary event.
+        /// Deactivates this circle widget that is blocked from the Rotary event.
         /// </summary>
-        /// <param name="widget">Target circle widget</param>
+        /// <param name="widget">Target the Circle widget.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static void Deactivate(this IRotaryActionWidget widget)
         {
             Interop.Eext.eext_rotary_object_event_activated_set(widget.CircleHandle, false);
         }
 
         /// <summary>
-        /// Activate this object can take Rotary event.
+        /// Activates this object that can take the Rotary event.
         /// </summary>
-        /// <param name="obj">Target object</param>
+        /// <param name="obj">Target object.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static void Activate(this EvasObject obj)
         {
             Interop.Eext.eext_rotary_object_event_activated_set(obj, true);
         }
 
         /// <summary>
-        /// Deactivate this object is blocked from Rotary event.
+        /// Deactivates this object that is blocked from the Rotary event.
         /// </summary>
-        /// <param name="obj">Target object</param>
+        /// <param name="obj">Target object.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public static void Deactivate(this EvasObject obj)
         {
             Interop.Eext.eext_rotary_object_event_activated_set(obj, false);
@@ -185,24 +203,32 @@ namespace ElmSharp.Wearable
     }
 
     /// <summary>
-    /// Handler for Rotary event
+    /// Handler for the Rotary event.
     /// </summary>
-    /// <param name="args">Rotary event information</param>
+    /// <param name="args">The Rotary event information.</param>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public delegate void RotaryEventHandler(RotaryEventArgs args);
 
     /// <summary>
-    /// RotaryEventArgs serve information for triggered rotary event.
+    /// The RotaryEventArgs serves information for the triggered Rotary event.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class RotaryEventArgs : EventArgs
     {
         /// <summary>
-        /// IsClockwise is true when Rotary device rotated clockwise direction or false on counter clockwise.
+        /// IsClockwise is true when the Rotary device rotated in the clockwise direction, or false on counter clockwise.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public bool IsClockwise { get; set; }
 
         /// <summary>
-        /// Timestamp of rotary event
+        /// Timestamp of the Rotary event.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public uint Timestamp { get; set; }
     }
 }