Release 4.0.0-preview1-00267

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

diff --git a/src/ElmSharp/ElmSharp/SmartEvent.cs b/src/ElmSharp/ElmSharp/SmartEvent.cs
index 6edbb7a..0742d0f 100755 (executable)
--- a/src/ElmSharp/ElmSharp/SmartEvent.cs
+++ b/src/ElmSharp/ElmSharp/SmartEvent.cs
@@ -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);
@@ -123,6 +133,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Destroy current object
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
@@ -138,6 +151,13 @@ namespace ElmSharp
             _handle = IntPtr.Zero;
         }
 
+        /// <summary>
+        /// Releases all resources currently used by this instance.
+        /// </summary>
+        /// <param name="disposing">
+        /// true if managed resources should be disposed
+        /// otherwise, false.
+        /// </param>
         protected virtual void Dispose(bool disposing)
         {
             if (disposing)
@@ -161,10 +181,10 @@ namespace ElmSharp
     /// This way, you can extend EvasObject's own <see cref="EvasObjectEvent"/>.
     /// They are defined by an event string, which identifies them uniquely.
     /// </summary>
-    /// <typeparam name="TEventArgs">The parameter for the event.</typeparam>
     public class SmartEvent : IInvalidatable
     {
         private SmartEvent<EventArgs> _smartEvent;
+
         private event EventHandler _handlers;
 
         /// <summary>
@@ -176,12 +196,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);
@@ -216,6 +245,9 @@ namespace ElmSharp
             _handlers?.Invoke(sender, e);
         }
 
+        /// <summary>
+        /// Destroy current object
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
@@ -230,6 +262,13 @@ namespace ElmSharp
             _smartEvent.MakeInvalidate();
         }
 
+        /// <summary>
+        /// Releases all resources currently used by this instance.
+        /// </summary>
+        /// <param name="disposing">
+        /// true if managed resources should be disposed
+        /// otherwise, false.
+        /// </param>
         protected virtual void Dispose(bool disposing)
         {
             if (disposing)
@@ -239,4 +278,4 @@ namespace ElmSharp
             }
         }
     }
-}
+}
\ No newline at end of file