Changeset 776 for trunk/sources/HeuristicLab.Core/KeyValueEventArgs.cs

Timestamp:

11/19/08 12:12:39 (16 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.Core namespace (#331)

File:

• trunk/sources/HeuristicLab.Core/KeyValueEventArgs.cs (modified) (2 diffs)

trunk/sources/HeuristicLab.Core/KeyValueEventArgs.cs

@@ -4 +4 @@
 
 namespace HeuristicLab.Core {
+  /// <summary>
+  /// Event arguments to be able to specify the affected key-value pair.
+  /// </summary>
   public class KeyValueEventArgs : EventArgs {
 
     private IItem key;
+    /// <summary>
+    /// Gets the affected key.
+    /// </summary>
     public IItem Key {
       get { return key; }
@@ -12 +18 @@
 
     private IItem value;
+    /// <summary>
+    /// Gets the affected value.
+    /// </summary>
     public IItem Value {
       get { return value; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="KeyValueEventArgs"/> with the given <paramref name="key"/>
+    /// and <paramref name="value"/>.
+    /// </summary>
+    /// <param name="key">The affected key.</param>
+    /// <param name="value">The affected value.</param>
     public KeyValueEventArgs(IItem key, IItem value) {
       this.key = key;