[ElmSharp] Fix XML documentation warnings. 93/153193/7
authorSungHyun Min <shyun.min@samsung.com>
Thu, 28 Sep 2017 05:58:57 +0000 (14:58 +0900)
committerSeungkeun Lee <sngn.lee@samsung.com>
Thu, 28 Sep 2017 06:30:33 +0000 (06:30 +0000)
Change-Id: Ic5293797e5d7e60dff3567c6905e8af2730595ba
Signed-off-by: SungHyun Min <shyun.min@samsung.com>
22 files changed:
src/ElmSharp/ElmSharp/Elementary.cs
src/ElmSharp/ElmSharp/EvasImage.cs [changed mode: 0644->0755]
src/ElmSharp/ElmSharp/EvasKeyEventArgs.cs [changed mode: 0644->0755]
src/ElmSharp/ElmSharp/EvasMap.cs
src/ElmSharp/ElmSharp/EvasObject.cs
src/ElmSharp/ElmSharp/EvasObjectEvent.cs [changed mode: 0644->0755]
src/ElmSharp/ElmSharp/GenGridItem.cs [changed mode: 0644->0755]
src/ElmSharp/ElmSharp/GenItem.cs [changed mode: 0644->0755]
src/ElmSharp/ElmSharp/GenItemClass.cs [changed mode: 0644->0755]
src/ElmSharp/ElmSharp/GenListItem.cs
src/ElmSharp/ElmSharp/ItemObject.cs
src/ElmSharp/ElmSharp/Point.cs
src/ElmSharp/ElmSharp/Point3D.cs
src/ElmSharp/ElmSharp/ProgressBar.cs
src/ElmSharp/ElmSharp/Rect.cs [changed mode: 0644->0755]
src/ElmSharp/ElmSharp/Size.cs
src/ElmSharp/ElmSharp/SmartEvent.cs [changed mode: 0644->0755]
src/ElmSharp/ElmSharp/Toolbar.cs
src/ElmSharp/ElmSharp/Transit.cs
src/ElmSharp/ElmSharp/Utility.cs [changed mode: 0644->0755]
src/ElmSharp/ElmSharp/Widget.cs
src/ElmSharp/ElmSharp/Window.cs

index c0c6abb..dc32fdf 100755 (executable)
@@ -29,10 +29,12 @@ namespace ElmSharp
         /// Directly show the focused region or item automatically
         /// </summary>
         Show,
+
         /// <summary>
         /// Do not show the focused region or item automatically
         /// </summary>
         None,
+
         /// <summary>
         /// Bring in the focused region or item automatically which might invole the scrolling
         /// </summary>
@@ -278,6 +280,7 @@ namespace ElmSharp
         /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public static void SetSystemScrollFriction(double timeSet)
+
         {
             BringInScrollFriction = timeSet;
         }
old mode 100644 (file)
new mode 100755 (executable)
index 2bf9407..c593e62
@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.ComponentModel;
 using System.IO;
@@ -165,7 +165,6 @@ namespace ElmSharp
             set
             {
                 Interop.Evas.evas_object_image_alpha_set(RealHandle, !value);
-
             }
         }
 
@@ -240,6 +239,10 @@ namespace ElmSharp
             return result;
         }
 
+        /// <summary>
+        /// Set the native surface of a given image of the canvas
+        /// </summary>
+        /// <param name="surface">The surface.</param>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public void SetNativeSurface(IntPtr surface)
         {
@@ -268,4 +271,4 @@ namespace ElmSharp
             return _handle != IntPtr.Zero ? _handle : Interop.Evas.evas_object_image_add(Interop.Evas.evas_object_evas_get(parent.Handle));
         }
     }
-}
+}
\ No newline at end of file
old mode 100644 (file)
new mode 100755 (executable)
index 378a7e9..953953a
@@ -1,4 +1,4 @@
-/*
+/*
  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the License);
@@ -30,10 +30,12 @@ namespace ElmSharp
         /// BackButton name in Platform
         /// </summary>
         public const string PlatformBackButtonName = "XF86Back";
+
         /// <summary>
         /// MenuButton name in Platform
         /// </summary>
         public const string PlatformMenuButtonName = "XF86Menu";
+
         /// <summary>
         /// HomeButton name in Platform
         /// </summary>
@@ -44,6 +46,9 @@ namespace ElmSharp
         /// </summary>
         public string KeyName { get; private set; }
 
+        /// <summary>
+        /// Sets or gets the flags.
+        /// </summary>
         public EvasEventFlag Flags
         {
             get
@@ -87,26 +92,32 @@ namespace ElmSharp
             /// Name string of the key pressed
             /// </summary>
             public string keyname;
+
             /// <summary>
             /// Data to be passed to the event
             /// </summary>
             public IntPtr data;
+
             /// <summary>
             /// Modifier keys pressed during the event
             /// </summary>
             public IntPtr modifiers;
+
             /// <summary>
             /// Locks info
             /// </summary>
             public IntPtr locks;
+
             /// <summary>
             /// Logical key: (example, shift+1 == exclamation)
             /// </summary>
             public string key;
+
             /// <summary>
             /// UTF8 string if this keystroke has produced a visible string to be ADDED
             /// </summary>
             public string str;
+
             /// <summary>
             /// UTF8 string if this keystroke has modified a string in the middle of being composed - this string replaces the previous one
             /// </summary>
@@ -118,10 +129,12 @@ namespace ElmSharp
             /// Event_flags
             /// </summary>
             public EvasEventFlag event_flags;
+
             /// <summary>
             ///
             /// </summary>
             public IntPtr dev;
+
             /// <summary>
             /// Keycode
             /// </summary>
@@ -139,10 +152,10 @@ namespace ElmSharp
         /// No fancy flags set
         /// </summary>
         None = 0,
+
         /// <summary>
         ///This event is being delivered but should be put "on hold" until the on hold flag is unset. the event should be used for informational purposes and maybe some indications visually, but not actually perform anything
         /// </summary>
         OnHold = 1,
     }
-
-}
+}
\ No newline at end of file
index 13fa2ee..405f494 100755 (executable)
@@ -42,6 +42,9 @@ namespace ElmSharp
             _ownership = false;
         }
 
+        /// <summary>
+        /// Destroy the EvasMap object.
+        /// </summary>
         ~EvasMap()
         {
             if (_ownership)
@@ -163,4 +166,4 @@ namespace ElmSharp
             Interop.Evas.evas_map_util_zoom(_evasMap, x, y, cx, cy);
         }
     }
-}
+}
\ No newline at end of file
index aea91a4..974386f 100755 (executable)
@@ -20,27 +20,91 @@ using System.Diagnostics;
 
 namespace ElmSharp
 {
+    /// <summary>
+    /// Enumeration for tooltip orientation.
+    /// </summary>
     public enum TooltipOrientation
     {
+        /// <summary>
+        /// Default value, Tooltip moves with mouse pointer.
+        /// </summary>
         None,
+
+        /// <summary>
+        /// Tooltip should appear at the top left of parent.
+        /// </summary>
         TopLeft,
+
+        /// <summary>
+        /// Tooltip should appear at the left of parent.
+        /// </summary>
         Top,
+
+        /// <summary>
+        /// Tooltip should appear at the top right of parent.
+        /// </summary>
         TopRight,
+
+        /// <summary>
+        /// Tooltip should appear at the left of parent.
+        /// </summary>
         Left,
+
+        /// <summary>
+        /// Tooltip should appear at the center of parent.
+        /// </summary>
         Center,
+
+        /// <summary>
+        /// Tooltip should appear at the right of parent.
+        /// </summary>
         Right,
+
+        /// <summary>
+        /// Tooltip should appear at the bottom left of parent.
+        /// </summary>
         BottomLeft,
+
+        /// <summary>
+        /// Tooltip should appear at the bottom of parent.
+        /// </summary>
         Bottom,
+
+        /// <summary>
+        /// Tooltip should appear at the bottom right of parent.
+        /// </summary>
         BottomRight,
     }
 
+    /// <summary>
+    /// Enumeration for aspect control.
+    /// </summary>
     public enum AspectControl
     {
-        None = 0, /* Preference on scaling unset */
-        Neither = 1, /* Same effect as unset preference on scaling */
-        Horizontal = 2, /* Use all horizontal container space to place an object, using the given aspect */
-        Vertical = 3, /* Use all vertical container space to place an object, using the given aspect */
-        Both = 4 /* Use all horizontal @b and vertical container spaces to place an object (never growing it out of those bounds), using the given aspect */
+        /// <summary>
+        /// Preference on scaling unset.
+        /// </summary>
+        None = 0,
+
+        /// <summary>
+        /// Same effect as unset preference on scaling.
+        /// </summary>
+        Neither = 1,
+
+        /// <summary>
+        /// Use all horizontal container space to place an object, using the given aspect
+        /// </summary>
+        Horizontal = 2,
+
+        /// <summary>
+        /// Use all vertical container space to place an object, using the given aspect.
+        /// </summary>
+        Vertical = 3,
+
+        /// <summary>
+        /// Use all horizontal @b and vertical container spaces to place an object (never growing it out of those bounds), using the given aspect.
+        /// </summary>
+        Both = 4
     }
 
     /// <summary>
@@ -58,9 +122,19 @@ namespace ElmSharp
         private Interop.Eext.EextEventCallback _backButtonHandler;
         private Interop.Eext.EextEventCallback _moreButtonHandler;
 
+        /// <summary>
+        /// Sets or gets the handle for EvasObject.
+        /// </summary>
         public IntPtr Handle { get; protected set; }
+
+        /// <summary>
+        /// Gets the parent object for EvasObject.
+        /// </summary>
         public EvasObject Parent { get; private set; }
 
+        /// <summary>
+        /// Sets or gets the real handle for EvasObject.
+        /// </summary>
         public IntPtr RealHandle
         {
             get
@@ -986,4 +1060,4 @@ namespace ElmSharp
             _eventStore.Add(item);
         }
     }
-}
+}
\ No newline at end of file
old mode 100644 (file)
new mode 100755 (executable)
index 6799be3..ac70309
@@ -27,6 +27,9 @@ namespace ElmSharp
     /// </summary>
     public interface IInvalidatable : IDisposable
     {
+        /// <summary>
+        /// Make current instance invalidate
+        /// </summary>
         void MakeInvalidate();
     }
 
@@ -248,6 +251,13 @@ namespace ElmSharp
         {
         }
 
+        /// <summary>
+        /// Creates and initializes a new instance of the EvasObjectEvent.
+        /// </summary>
+        /// <param name="sender">EvasObject class belong to</param>
+        /// <param name="handle">EvasObject handle</param>
+        /// <param name="type">EvasObjectCallbackType</param>
+        /// <param name="parser">SmartEventInfoParser</param>
         [EditorBrowsableAttribute(EditorBrowsableState.Never)]
         public EvasObjectEvent(EvasObject sender, IntPtr handle, EvasObjectCallbackType type, SmartEventInfoParser parser)
         {
@@ -267,6 +277,9 @@ namespace ElmSharp
         {
         }
 
+        /// <summary>
+        /// Destroy the EvasObjectEvent object.
+        /// </summary>
         ~EvasObjectEvent()
         {
             Dispose(false);
@@ -335,9 +348,6 @@ namespace ElmSharp
             }
         }
 
-        /// <summary>
-        /// Destroy Current Obj
-        /// </summary>
         public void Dispose()
         {
             Dispose(true);
@@ -374,12 +384,21 @@ namespace ElmSharp
         {
         }
 
+        /// <summary>
+        /// Creates and initializes a new instance of the EvasObjectEvent.
+        /// </summary>
+        /// <param name="sender">EvasObject class belong to</param>
+        /// <param name="handle">EvasObject handle</param>
+        /// <param name="type">EvasObjectCallbackType</param>
         [EditorBrowsableAttribute(EditorBrowsableState.Never)]
         public EvasObjectEvent(EvasObject sender, IntPtr handle, EvasObjectCallbackType type)
         {
             _evasObjectEvent = new EvasObjectEvent<EventArgs>(sender, handle, type, null);
         }
 
+        /// <summary>
+        /// Destroy the EvasObjectEvent object.
+        /// </summary>
         ~EvasObjectEvent()
         {
             Dispose(false);
@@ -426,9 +445,6 @@ namespace ElmSharp
             }
         }
 
-        /// <summary>
-        /// Destroy Current Obj
-        /// </summary>
         public void Dispose()
         {
             Dispose(true);
old mode 100644 (file)
new mode 100755 (executable)
index afdede0..13e1abf
@@ -50,6 +50,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Sets or gets the cursor to be shown when mouse is over the gengrid item.
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public override string Cursor
         {
@@ -70,6 +73,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Sets or gets the style for this item cursor.
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public override string CursorStyle
         {
@@ -83,6 +89,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Sets or gets the cursor engine only usage for this item cursor.
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public override bool IsUseEngineCursor
         {
@@ -97,7 +106,7 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Gets or sets the style of given gengrid item's tooltip.
+        /// Sets or gets or sets the style of given gengrid item's tooltip.
         /// </summary>
         public override string TooltipStyle
         {
@@ -111,6 +120,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Get the gengrid item's select mode.
+        /// </summary>
         public override GenItemSelectionMode SelectionMode
         {
             get
@@ -149,11 +161,18 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Set the text to be shown in the gengrid item.
+        /// </summary>
+        /// <param name="tooltip">The text to set.</param>
         public override void SetTooltipText(string tooltip)
         {
             Interop.Elementary.elm_gengrid_item_tooltip_text_set(Handle, tooltip);
         }
 
+        /// <summary>
+        /// Unset tooltip from item.
+        /// </summary>
         public override void UnsetTooltip()
         {
             Interop.Elementary.elm_gengrid_item_tooltip_unset(Handle);
@@ -172,6 +191,9 @@ namespace ElmSharp
             Interop.Elementary.elm_gengrid_item_update(Handle);
         }
 
+        /// <summary>
+        /// Set the content to be shown in the tooltip item.
+        /// </summary>
         protected override void UpdateTooltipDelegate()
         {
             Interop.Elementary.elm_gengrid_item_tooltip_content_cb_set(Handle,
old mode 100644 (file)
new mode 100755 (executable)
index ca50c53..c037d73
@@ -71,6 +71,9 @@ namespace ElmSharp
         /// </summary>
         public GenItemClass ItemClass { get; protected set; }
 
+        /// <summary>
+        /// Sets or gets tooltip content delegate.
+        /// </summary>
         public GetTooltipContentDelegate TooltipContentDelegate
         {
             get
@@ -89,9 +92,19 @@ namespace ElmSharp
         /// </summary>
         public abstract GenItemSelectionMode SelectionMode { get; set; }
 
+        /// <summary>
+        /// Sets or gets the cursor to be shown when mouse is over the gengrid item
+        /// </summary>
         public abstract string Cursor { get; set; }
+
+        /// <summary>
+        /// Sets or gets the style for this item cursor.
+        /// </summary>
         public abstract string CursorStyle { get; set; }
 
+        /// <summary>
+        /// Sets or gets the cursor engine only usage for this item cursor.
+        /// </summary>
         public abstract bool IsUseEngineCursor { get; set; }
 
         /// <summary>
@@ -109,7 +122,15 @@ namespace ElmSharp
         /// </summary>
         public abstract string TooltipStyle { get; set; }
 
+        /// <summary>
+        /// Set tooltip text.
+        /// </summary>
+        /// <param name="tooltip">The text to set.</param>
         public abstract void SetTooltipText(string tooltip);
+
+        /// <summary>
+        /// Unset tooltip.
+        /// </summary>
         public abstract void UnsetTooltip();
 
         /// <summary>
@@ -127,6 +148,9 @@ namespace ElmSharp
             ItemClass = null;
         }
 
+        /// <summary>
+        /// Abstract method for updating tooltip content.
+        /// </summary>
         protected abstract void UpdateTooltipDelegate();
     }
-}
+}
\ No newline at end of file
old mode 100644 (file)
new mode 100755 (executable)
index 17fe11a..f334edf
@@ -83,6 +83,9 @@ namespace ElmSharp
             ReleaseItemClass(unmanaged);
         }
 
+        /// <summary>
+        /// Destroy the GenItemClass object.
+        /// </summary>
         ~GenItemClass()
         {
             Dispose(false);
@@ -151,11 +154,19 @@ namespace ElmSharp
             DeleteHandler?.Invoke(data);
         }
 
+        /// <summary>
+        /// Create a new genlist item class in a given genlist widget.
+        /// </summary>
+        /// <returns>The new item class object.</returns>
         protected virtual IntPtr CreateItemClass()
         {
             return Interop.Elementary.elm_genlist_item_class_new();
         }
 
+        /// <summary>
+        /// Remove an item class in a given genlist widget.
+        /// </summary>
+        /// <param name="unmanagedPtr">The object to be removed.</param>
         protected virtual void ReleaseItemClass(IntPtr unmanagedPtr)
         {
             Interop.Elementary.elm_genlist_item_class_free(unmanagedPtr);
@@ -207,17 +218,32 @@ namespace ElmSharp
         }
     }
 
+    /// <summary>
+    /// It represents the GenGrid item class definition field details.
+    /// </summary>
     public class GenGridItemClass : GenItemClass
     {
+        /// <summary>
+        /// Create the GenGridItemClass instance.
+        /// </summary>
+        /// <param name="style">The item display style.</param>
         public GenGridItemClass(string style) : base(style)
         {
         }
 
+        /// <summary>
+        /// Add a new gengrid item class in a given gengrid widget.
+        /// </summary>
+        /// <returns>The new instance.</returns>
         protected override IntPtr CreateItemClass()
         {
             return Interop.Elementary.elm_gengrid_item_class_new();
         }
 
+        /// <summary>
+        /// Remove an item class in a given gengrid widget.
+        /// </summary>
+        /// <param name="unmanagedPtr">The object to be removed.</param>
         protected override void ReleaseItemClass(IntPtr unmanagedPtr)
         {
             Interop.Elementary.elm_gengrid_item_class_free(unmanagedPtr);
index f12ff86..b21c550 100755 (executable)
@@ -173,6 +173,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Sets or gets the content to be shown in the tooltip item
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public override string Cursor
         {
@@ -193,6 +196,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Sets or gets the style for this item cursor.
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public override string CursorStyle
         {
@@ -206,6 +212,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Sets or gets the cursor engine only usage for this item cursor.
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public override bool IsUseEngineCursor
         {
@@ -219,11 +228,18 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Set the text to be shown in the genlist item.
+        /// </summary>
+        /// <param name="tooltip">The text to set in the content.</param>
         public override void SetTooltipText(string tooltip)
         {
             Interop.Elementary.elm_genlist_item_tooltip_text_set(Handle, tooltip);
         }
 
+        /// <summary>
+        /// Unset tooltip from item.
+        /// </summary>
         public override void UnsetTooltip()
         {
             Interop.Elementary.elm_genlist_item_tooltip_unset(Handle);
@@ -305,6 +321,9 @@ namespace ElmSharp
             Interop.Elementary.elm_genlist_item_item_class_update((IntPtr)Handle, itemClass.UnmanagedPtr);
         }
 
+        /// <summary>
+        /// Set the content to be shown in the tooltip item.
+        /// </summary>
         protected override void UpdateTooltipDelegate()
         {
             Interop.Elementary.elm_genlist_item_tooltip_content_cb_set(Handle,
@@ -313,4 +332,4 @@ namespace ElmSharp
                 null);
         }
     }
-}
+}
\ No newline at end of file
index 9549e98..2c356ec 100755 (executable)
@@ -354,7 +354,7 @@ namespace ElmSharp
             /// <summary>
             /// Creates and initializes a new instance of ItemEvasObject class.
             /// </summary>
-            /// <param name="handle">IntPtr</param>
+            /// <param name="parent">IntPtr</param>
             public ItemEvasObject(IntPtr parent) : base()
             {
                 _parent = parent;
index 3fe04cd..bd033c3 100755 (executable)
@@ -33,11 +33,19 @@ namespace ElmSharp
         /// </summary>
         public int Y;
 
+        /// <summary>
+        /// A human-readable representation of the <see cref="T:Tizen.UI.Point" />.
+        /// </summary>
+        /// <returns>The string is formatted as "{{X={0} Y={1}}}".</returns>
         public override string ToString()
         {
             return string.Format("{{X={0} Y={1}}}", X, Y);
         }
 
+        /// <summary>
+        /// Gets hash code.
+        /// </summary>
+        /// <returns>The hash code.</returns>
         public override int GetHashCode()
         {
             unchecked
@@ -81,4 +89,4 @@ namespace ElmSharp
             return !p1.Equals(p2);
         }
     }
-}
+}
\ No newline at end of file
index ebb8afb..62a2007 100755 (executable)
@@ -38,11 +38,16 @@ namespace ElmSharp
         /// </summary>
         public int Z;
 
+        /// <summary>
+        /// A human-readable representation of the <see cref="T:Tizen.UI.Point3D" />.
+        /// </summary>
+        /// <returns>The string is formatted as "{{X={0} Y={1} Z={2}}}".</returns>
         public override string ToString()
         {
             return string.Format("{{X={0} Y={1} Z={2}}}", X, Y, Z);
         }
 
+        ///
         public override int GetHashCode()
         {
             unchecked
@@ -89,4 +94,4 @@ namespace ElmSharp
             return !p1.Equals(p2);
         }
     }
-}
+}
\ No newline at end of file
index 709d6f2..ad1c134 100755 (executable)
@@ -160,6 +160,9 @@ namespace ElmSharp
             Interop.Elementary.elm_progressbar_pulse(RealHandle, true);
         }
 
+        /// <summary>
+        /// Stops a given progress bar "pulsing" animation, if its under that mode.
+        /// </summary>
         [Obsolete("use StopPulse instead")]
         public void StopPluse()
         {
old mode 100644 (file)
new mode 100755 (executable)
index 2f7a544..acce92f
@@ -39,6 +39,7 @@ namespace ElmSharp
             Width = w;
             Height = h;
         }
+
         /// <summary>
         /// Gets or sets the position of this Rectangle on the X axis.
         /// </summary>
@@ -89,11 +90,19 @@ namespace ElmSharp
         /// </summary>
         public Size Size { get { return new Size { Width = Width, Height = Height }; } }
 
+        /// <summary>
+        /// A human-readable representation of the <see cref="T:Tizen.UI.Rect" />.
+        /// </summary>
+        /// <returns>The string is formatted as "{{X={0} Y={1} Width={2} Height={3}}}".</returns>
         public override string ToString()
         {
             return string.Format("{{X={0} Y={1} Width={2} Height={3}}}", X, Y, Width, Height);
         }
 
+        /// <summary>
+        /// Gets the hash code.
+        /// </summary>
+        /// <returns>The hash code.</returns>
         public override int GetHashCode()
         {
             unchecked
@@ -141,4 +150,4 @@ namespace ElmSharp
             return !r1.Equals(r2);
         }
     }
-}
+}
\ No newline at end of file
index c2af5e2..97aeeef 100755 (executable)
@@ -53,6 +53,10 @@ namespace ElmSharp
             return string.Format("{{Width={0} Height={1}}}", Width, Height);
         }
 
+        /// <summary>
+        /// Gets hash code.
+        /// </summary>
+        /// <returns>The hash code.</returns>
         public override int GetHashCode()
         {
             unchecked
@@ -96,4 +100,4 @@ namespace ElmSharp
             return !s1.Equals(s2);
         }
     }
-}
+}
\ No newline at end of file
old mode 100644 (file)
new mode 100755 (executable)
index f413f82..22aeb2e
@@ -56,6 +56,13 @@ namespace ElmSharp
         {
         }
 
+        /// <summary>
+        /// reates and initializes a new instance of the SmartEvent class.
+        /// </summary>
+        /// <param name="sender">The source of the event.</param>
+        /// <param name="handle">Teh event handler.</param>
+        /// <param name="eventName">The event name.</param>
+        /// <param name="parser">The event parser.</param>
         [EditorBrowsableAttribute(EditorBrowsableState.Never)]
         public SmartEvent(EvasObject sender, IntPtr handle, string eventName, SmartEventInfoParser parser)
         {
@@ -75,6 +82,9 @@ namespace ElmSharp
         {
         }
 
+        /// <summary>
+        /// Destroy the SmartEvent object.
+        /// </summary>
         ~SmartEvent()
         {
             Dispose(false);
@@ -164,6 +174,7 @@ namespace ElmSharp
     public class SmartEvent : IInvalidatable
     {
         private SmartEvent<EventArgs> _smartEvent;
+
         private event EventHandler _handlers;
 
         /// <summary>
@@ -175,12 +186,21 @@ namespace ElmSharp
         {
         }
 
+        /// <summary>
+        /// Creates and initializes a new instance of the SmartEvent class.
+        /// </summary>
+        /// <param name="sender">The source of the event.</param>
+        /// <param name="handle">The event handler.</param>
+        /// <param name="eventName">The event name.</param>
         [EditorBrowsableAttribute(EditorBrowsableState.Never)]
         public SmartEvent(EvasObject sender, IntPtr handle, string eventName)
         {
             _smartEvent = new SmartEvent<EventArgs>(sender, handle, eventName, null);
         }
 
+        /// <summary>
+        /// Destroy the SmartEvent object.
+        /// </summary>
         ~SmartEvent()
         {
             Dispose(false);
@@ -238,4 +258,4 @@ namespace ElmSharp
             }
         }
     }
-}
+}
\ No newline at end of file
index cd1bfd9..49d7178 100755 (executable)
@@ -211,6 +211,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Sets or gets toolbar's current orientation.
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public bool IsHorizontal
         {
index 8ee276a..018309b 100755 (executable)
@@ -50,7 +50,8 @@ namespace ElmSharp
         public Transit()
         {
             _handle = Interop.Elementary.elm_transit_add();
-            DeletedCallback = (ptr1, ptr2) => {
+            DeletedCallback = (ptr1, ptr2) =>
+            {
                 Deleted?.Invoke(this, EventArgs.Empty);
                 Dispose(true);
             };
@@ -59,6 +60,9 @@ namespace ElmSharp
             ((INotifyCollectionChanged)_chains).CollectionChanged += OnChaninCollectionChanged;
         }
 
+        /// <summary>
+        /// Destroy the Transit object.
+        /// </summary>
         ~Transit()
         {
             Dispose(false);
@@ -383,4 +387,4 @@ namespace ElmSharp
             Interop.Elementary.elm_transit_chain_transit_del(_handle, transit._handle);
         }
     }
-}
+}
\ No newline at end of file
old mode 100644 (file)
new mode 100755 (executable)
index baff802..01d4be2
@@ -16,6 +16,9 @@
 
 namespace ElmSharp
 {
+    /// <summary>
+    /// This class is a static class for a utility methods.
+    /// </summary>
     public static class Utility
     {
         /// <summary>
index f1df744..040d132 100755 (executable)
@@ -70,6 +70,9 @@ namespace ElmSharp
         internal Color _backgroundColor = Color.Default;
         internal int _opacity = Color.Default.A;
 
+        /// <summary>
+        /// Creates and initializes a new instance of Widget class.
+        /// </summary>
         protected Widget()
         {
         }
index 7270a58..74ab8db 100755 (executable)
@@ -71,12 +71,30 @@ namespace ElmSharp
         Transparent = 3,
     }
 
+    /// <summary>
+    /// Enumeration for the keygrab modes of window.
+    /// </summary>
     [EditorBrowsable(EditorBrowsableState.Never)]
     public enum KeyGrabMode
     {
+        /// <summary>
+        /// Unknown keygrab mode
+        /// </summary>
         Shared = 256,
+
+        /// <summary>
+        /// Getting the grabbed-key together with the other client windows.
+        /// </summary>
         Topmost = 512,
+
+        /// <summary>
+        /// Getting the grabbed-key only when window is top of the stack.
+        /// </summary>
         Exclusive = 1024,
+
+        /// <summary>
+        /// Getting the grabbed-key exclusively regardless of window's position.
+        /// </summary>
         OverrideExclusive = 2048,
     }
 
@@ -350,6 +368,9 @@ namespace ElmSharp
             _rotationChanged.On += (s, e) => RotationChanged?.Invoke(this, EventArgs.Empty);
         }
 
+        /// <summary>
+        /// Creates and initializes a new instance of the Window class.
+        /// </summary>
         protected Window()
         {
         }
@@ -422,6 +443,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Sets or gets available rotation degree.
+        /// </summary>
         [Obsolete("Sorry, it's error typo of AvailableRotations, please use AvailableRotations")]
         public DisplayRotation AavailableRotations { get; set; }
 
@@ -517,6 +541,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Sets or gets the iconified state of a window.
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public bool Iconified
         {
@@ -970,12 +997,23 @@ namespace ElmSharp
             Interop.Elementary.elm_win_resize_object_add(Handle, obj);
         }
 
+        /// <summary>
+        /// Set keygrab value of the window.
+        /// This function grabs the key of window using grab_mode.
+        /// </summary>
+        /// <param name="keyname">The keyname to grab.</param>
+        /// <param name="mode">According to the grabmode, it can grab key differently</param>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public void WinKeyGrab(string keyname, KeyGrabMode mode)
         {
             Interop.Elementary.elm_win_keygrab_set(RealHandle, keyname, 0, 0, 0, mode);
         }
 
+        /// <summary>
+        /// Unset keygrab value of the window.
+        /// This function unset keygrab value.Ungrab key of window.
+        /// </summary>
+        /// <param name="keyname">The keyname to grab.</param>
         [EditorBrowsable(EditorBrowsableState.Never)]
         public void WinKeyUngrab(string keyname)
         {
@@ -1045,4 +1083,4 @@ namespace ElmSharp
             return (DisplayRotation)orientation;
         }
     }
-}
+}
\ No newline at end of file