Changeset 776 for trunk/sources/HeuristicLab.Core/Interfaces/IConstraint.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/Interfaces/IConstraint.cs (modified) (1 diff)

trunk/sources/HeuristicLab.Core/Interfaces/IConstraint.cs

@@ -25 +25 @@
 
 namespace HeuristicLab.Core {
+  /// <summary>
+  /// Interface to represent restrictions.
+  /// </summary>
   public interface IConstraint : IItem {
+    /// <summary>
+    /// Gets the description of the current instance.
+    /// </summary>
     string Description { get; }
 
+    /// <summary>
+    /// Checks whether the given <paramref name="data"/> fulfills the current constraint.
+    /// </summary>
+    /// <param name="data">The item to check.</param>
+    /// <returns><c>true</c> if the current instance could be fulfilled, <c>false</c> otherwise.</returns>
     bool Check(IItem data);
   }