Setting since_tizen 3/4 on Tizen.NET API

[platform/core/csapi/tizenfx.git] / src / Tizen.Maps / Tizen.Maps / Overlay.cs

diff --git a/src/Tizen.Maps/Tizen.Maps/Overlay.cs b/src/Tizen.Maps/Tizen.Maps/Overlay.cs
index 613721f..d1551c3 100755 (executable)
--- a/src/Tizen.Maps/Tizen.Maps/Overlay.cs
+++ b/src/Tizen.Maps/Tizen.Maps/Overlay.cs
@@ -20,19 +20,22 @@ using EvasObject = ElmSharp.EvasObject;
 namespace Tizen.Maps
 {
     /// <summary>
-    /// Overlay map object
+    /// Overlay map object.
     /// </summary>
+    /// <since_tizen> 3 </since_tizen>
     public class Overlay : MapObject, IDisposable
     {
         internal Interop.OverlayHandle handle;
-        private EvasObject _containedObject;
 
         /// <summary>
-        /// Creates normal overlay map object
+        /// Creates a normal overlay map object.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="coordinates"></param>
         /// <param name="objectToContain"></param>
-        public Overlay(Geocoordinates coordinates, EvasObject objectToContain) : this(coordinates, objectToContain, Interop.ViewOverlayType.Normal)
+        /// <exception cref="ArgumentException">Thrown when the input coordinates or objectToContain are invalid.</exception>
+        public Overlay(Geocoordinates coordinates, EvasObject objectToContain)
+            : this(coordinates, objectToContain, Interop.ViewOverlayType.Normal)
         {
         }
 
@@ -43,11 +46,13 @@ namespace Tizen.Maps
             {
                 err.ThrowIfFailed("given coordinates or parent evas object is null");
             }
-
-            _containedObject = objectToContain;
-            handle = new Interop.OverlayHandle(coordinates.handle, objectToContain, Interop.ViewOverlayType.Normal);
+            handle = new Interop.OverlayHandle(coordinates.handle, objectToContain, type);
         }
 
+        /// <summary>
+        /// Gets or sets the visibility of an overlay map object.
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public override bool IsVisible
         {
             get { return handle.IsVisible; }
@@ -55,8 +60,9 @@ namespace Tizen.Maps
         }
 
         /// <summary>
-        /// Geographical coordinates for overlay
+        /// Gets or sets geographical coordinates for an overlay map object.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public Geocoordinates Coordinates
         {
             get
@@ -72,8 +78,9 @@ namespace Tizen.Maps
         }
 
         /// <summary>
-        /// Minimum zoom level for overlay
+        /// Gets or sets minimum zoom level for an overlay map object.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public int MinimumZoomLevel
         {
             get
@@ -87,8 +94,9 @@ namespace Tizen.Maps
         }
 
         /// <summary>
-        /// Maximum zoom lever for overlay
+        /// Gets or sets maximum zoom lever for an overlay map object.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public int MaximumZoomLevel
         {
             get
@@ -120,6 +128,11 @@ namespace Tizen.Maps
         #region IDisposable Support
         private bool _disposedValue = false;
 
+        /// <summary>
+        /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+        /// </summary>
+        /// <param name="disposing">If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed.</param>
+        /// <since_tizen> 3 </since_tizen>
         protected virtual void Dispose(bool disposing)
         {
             if (!_disposedValue)
@@ -129,32 +142,54 @@ namespace Tizen.Maps
             }
         }
 
+        /// <summary>
+        /// Releases all the resources used by this object.
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public void Dispose()
         {
             Dispose(true);
+            GC.SuppressFinalize(this);
         }
         #endregion
     }
 
     /// <summary>
-    /// Bubble overlay map object
+    /// The bubble overlay map object.
     /// </summary>
+    /// <since_tizen> 3 </since_tizen>
     public class BubbleOverlay : Overlay
     {
-        public BubbleOverlay(Geocoordinates coordinates, EvasObject objectToContain) : base(coordinates, objectToContain, Interop.ViewOverlayType.Bubble)
+        /// <summary>
+        /// Creates a bubble overlay.
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
+        /// <param name="coordinates">The geographical coordinates to be pointed.</param>
+        /// <param name="objectToContain">The EvasObject to be shown.</param>
+        /// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
+        /// <exception cref="ArgumentException">Thrown when the input coordinates or objectToContain are invalid.</exception>
+        public BubbleOverlay(Geocoordinates coordinates, EvasObject objectToContain)
+            : base(coordinates, objectToContain, Interop.ViewOverlayType.Bubble)
         {
         }
     }
 
     /// <summary>
-    /// Box Overlay map object
+    /// The box overlay map object.
     /// </summary>
+    /// <since_tizen> 3 </since_tizen>
     public class BoxOverlay : Overlay
     {
         /// <summary>
-        /// Creates Box overlay
+        /// Creates a box overlay.
         /// </summary>
-        public BoxOverlay(Geocoordinates coordinates, EvasObject objectToContain) : base(coordinates, objectToContain, Interop.ViewOverlayType.Box)
+        /// <since_tizen> 3 </since_tizen>
+        /// <param name="coordinates">The geographical coordinates to be pointed.</param>
+        /// <param name="objectToContain">The EvasObject to be shown.</param>
+        /// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
+        /// <exception cref="ArgumentException">Thrown when the input coordinates or objectToContain are invalid</exception>
+        public BoxOverlay(Geocoordinates coordinates, EvasObject objectToContain)
+            : base(coordinates, objectToContain, Interop.ViewOverlayType.Box)
         {
         }
     }