[ACR-564] deprecate unused API

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

diff --git a/src/ElmSharp/ElmSharp/Container.cs b/src/ElmSharp/ElmSharp/Container.cs
index b9c4b08..5693ed0 100644 (file)
--- a/src/ElmSharp/ElmSharp/Container.cs
+++ b/src/ElmSharp/ElmSharp/Container.cs
@@ -19,14 +19,43 @@ using System.Collections.Generic;
 
 namespace ElmSharp
 {
+    /// <summary>
+    /// It inherits <see cref="Widget"/>.
+    /// The Container is an abstract class.
+    /// The other class inherits it to elementary, which is about displaying
+    /// its widgets in a nice layout.
+    /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public abstract class Container : Widget
     {
         HashSet<EvasObject> _children = new HashSet<EvasObject>();
 
-        public Container(EvasObject parent) : base(parent)
+        /// <summary>
+        /// Creates and initializes a new instance of the class, which inherit from the Container.
+        /// </summary>
+        /// <param name="parent">The parent is a given object, which will be attached by the Container
+        /// as a child. It's <see cref="EvasObject"/> type.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
+        protected Container(EvasObject parent) : base(parent)
         {
         }
 
+        /// <summary>
+        /// Creates and initializes a new instance of the Container class.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
+        protected Container()
+        {
+        }
+
+        /// <summary>
+        /// Sets the background color of a given Container.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public override Color BackgroundColor
         {
             set
@@ -43,22 +72,51 @@ namespace ElmSharp
             }
         }
 
-        internal void AddChild(EvasObject obj)
+        /// <summary>
+        /// Gets the collection of a child EvasObject of the Container.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
+        protected IEnumerable<EvasObject> Children => _children;
+
+        /// <summary>
+        /// Add the EvasObject object as a child of the Container.
+        /// </summary>
+        /// <param name="obj">The EvasObject object to be added.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
+        protected void AddChild(EvasObject obj)
         {
             _children.Add(obj);
             obj.Deleted += OnChildDeleted;
         }
 
-        internal void RemoveChild(EvasObject obj)
+        /// <summary>
+        /// Removes the EvasObject object as a child of the Container.
+        /// </summary>
+        /// <param name="obj">The EvasObject object to be removed.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
+        protected void RemoveChild(EvasObject obj)
         {
             _children.Remove(obj);
         }
 
-        internal void ClearChildren()
+        /// <summary>
+        /// Clears all the children of the Container.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
+        protected void ClearChildren()
         {
             _children.Clear();
         }
 
+        /// <summary>
+        /// The Container callback that is invoked when a child is removed.
+        /// </summary>
+        /// <param name="sender">The called Container.</param>
+        /// <param name="a"><see cref="EventArgs"/></param>
         void OnChildDeleted(object sender, EventArgs a)
         {
             _children.Remove((EvasObject)sender);