From 62c85e805d5a2c3a7248792b569f2331fe333590 Mon Sep 17 00:00:00 2001
From: Simon Gockner <simon.gockner@gmail.com>
Date: Mon, 9 Mar 2020 10:31:01 +0100
Subject: [PATCH] - add comments

---
 GBase.Api/GBaseEntryChangedEventArgs.cs | 12 ++++++++++++
 GBase.Api/INotifyGBaseEntryChanged.cs   |  3 +++
 GBase.Api/NotifyGBaseEntryChanged.cs    | 17 +++++++++++++++--
 3 files changed, 30 insertions(+), 2 deletions(-)

diff --git a/GBase.Api/GBaseEntryChangedEventArgs.cs b/GBase.Api/GBaseEntryChangedEventArgs.cs
index 8e2f077..8fcd09b 100644
--- a/GBase.Api/GBaseEntryChangedEventArgs.cs
+++ b/GBase.Api/GBaseEntryChangedEventArgs.cs
@@ -11,13 +11,25 @@ namespace GBase.Api
     /// </summary>
     public class GBaseEntryChangedEventArgs : EventArgs //TODO: Rename to GBaseValueChanged or EntryUpdated?
     {
+        /// <summary>
+        /// <see cref="EventArgs"/> for the <see cref="INotifyGBaseEntryChanged"/> event
+        /// </summary>
+        /// <param name="columnName">The name of the IGBaseColumn</param>
+        /// <param name="value">The new value</param>
         public GBaseEntryChangedEventArgs(string columnName, object value)
         {
             ColumnName = columnName;
             Value = value;
         }
 
+        /// <summary>
+        /// The name of the IGBaseColumn
+        /// </summary>
         public string ColumnName { get; }
+
+        /// <summary>
+        /// The new value
+        /// </summary>
         public object Value { get; }
     }
 }
\ No newline at end of file
diff --git a/GBase.Api/INotifyGBaseEntryChanged.cs b/GBase.Api/INotifyGBaseEntryChanged.cs
index 220f750..fb73c51 100644
--- a/GBase.Api/INotifyGBaseEntryChanged.cs
+++ b/GBase.Api/INotifyGBaseEntryChanged.cs
@@ -11,6 +11,9 @@ namespace GBase.Api
     /// </summary>
     public interface INotifyGBaseEntryChanged
     {
+        /// <summary>
+        /// Notify the GBase that an entry has changed
+        /// </summary>
         static event EventHandler<GBaseEntryChangedEventArgs> GBaseEntryChanged;
     }
 }
\ No newline at end of file
diff --git a/GBase.Api/NotifyGBaseEntryChanged.cs b/GBase.Api/NotifyGBaseEntryChanged.cs
index 87f3985..5c78c67 100644
--- a/GBase.Api/NotifyGBaseEntryChanged.cs
+++ b/GBase.Api/NotifyGBaseEntryChanged.cs
@@ -11,13 +11,26 @@ namespace GBase.Api
     /// </summary>
     public abstract class NotifyGBaseEntryChanged : INotifyGBaseEntryChanged //TODO: Rename to GBaseValueChanged or EntryUpdated?
     {
+        /// <summary>
+        /// Notify the GBase that an entry has changed
+        /// </summary>
         public event EventHandler<GBaseEntryChangedEventArgs> GBaseEntryChanged;
 
-        protected void RaiseGBaseEntryChanged(object sender, string propertyName, object value)
+        /// <summary>
+        /// Raise the <see cref="GBaseEntryChanged"/> event
+        /// </summary>
+        /// <param name="sender">The sender</param>
+        /// <param name="columnName">The name of the IGBaseColumn</param>
+        /// <param name="value">The new value</param>
+        protected void RaiseGBaseEntryChanged(object sender, string columnName, object value)
         {
-            GBaseEntryChanged?.BeginInvoke(sender, new GBaseEntryChangedEventArgs(propertyName, value), GBaseEntryChangedCallback, null);
+            GBaseEntryChanged?.BeginInvoke(sender, new GBaseEntryChangedEventArgs(columnName, value), GBaseEntryChangedCallback, null);
         }
 
+        /// <summary>
+        /// Callback for the <see cref="GBaseEntryChanged"/> event
+        /// </summary>
+        /// <param name="asyncResult">The <see cref="IAsyncResult"/></param>
         private void GBaseEntryChangedCallback(IAsyncResult asyncResult)
         {
             GBaseEntryChanged?.EndInvoke(asyncResult); //TestMe: Does this work? Or is there something to be done with the asyncResult