[NUI] TCSACR-226 code change (#1032)

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

diff --git a/src/ElmSharp/ElmSharp/Icon.cs b/src/ElmSharp/ElmSharp/Icon.cs
index 6960e87..070b447 100644 (file)
--- a/src/ElmSharp/ElmSharp/Icon.cs
+++ b/src/ElmSharp/ElmSharp/Icon.cs
@@ -18,19 +18,51 @@ using System;
 
 namespace ElmSharp
 {
+    /// <summary>
+    /// Enumeration for the icon lookup order. Should look for icons in the theme, FDO paths, or both.
+    /// </summary>
+    /// <since_tizen> preview </since_tizen>
     public enum IconLookupOrder
     {
+        /// <summary>
+        /// Icon look up order: freedesktop, theme.
+        /// </summary>
         FreeDesktopFirst = 0,
+        /// <summary>
+        /// Icon look up order: theme, freedesktop.
+        /// </summary>
         ThemeFirst,
+        /// <summary>
+        /// Icon look up order: freedesktop.
+        /// </summary>
         FreeDesktopOnly,
+        /// <summary>
+        /// Icon look up order: theme.
+        /// </summary>
         ThemeOnly
     }
+
+    /// <summary>
+    /// The Icon is a widget that displays the standard icon images ("delete", "edit", "arrows", etc.)
+    /// or images coming from a custom file (PNG, JPG, EDJE, etc.), on the icon context.
+    /// Inherits Image.
+    /// </summary>
+    /// <since_tizen> preview </since_tizen>
     public class Icon : Image
     {
+        /// <summary>
+        /// Creates and initializes a new instance of the Icon class.
+        /// </summary>
+        /// <param name="parent">The parent is a given container, which will be attached by Icon as a child. It's <see cref="EvasObject"/> type.</param>
+        /// <since_tizen> preview </since_tizen>
         public Icon(EvasObject parent) : base(parent)
         {
         }
 
+        /// <summary>
+        /// Sets or gets the standard icon name of a given Icon widget.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
         public string StandardIconName
         {
             get
@@ -43,6 +75,10 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Sets or gets the icon lookup order of a given Icon widget.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
         public IconLookupOrder IconLookupOrder
         {
             get
@@ -55,11 +91,23 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Sets the file that is used, but uses a generated thumbnail.
+        /// </summary>
+        /// <param name="file">The path to the file that is used as an icon image.</param>
+        /// <param name="group">The group that the icon belongs to.</param>
+        /// <since_tizen> preview </since_tizen>
         public void SetThumb(string file, string group)
         {
             Interop.Elementary.elm_icon_thumb_set(RealHandle, file, group);
         }
 
+        /// <summary>
+        /// Adds a new icon object to the parent.
+        /// </summary>
+        /// <param name="parent">EvasObject</param>
+        /// <returns>The new object, otherwise null if it cannot be created.</returns>
+        /// <since_tizen> preview </since_tizen>
         protected override IntPtr CreateHandle(EvasObject parent)
         {
             IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle);