Changeset 1176 for trunk/sources/HeuristicLab.Constraints/ConstraintBase.cs

Timestamp:

01/27/09 09:31:06 (15 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.BitVector and HeuristicLab.Constraints namespace and changed a comment in HeuristicLab.IntVector namespace(#331)

File:

• trunk/sources/HeuristicLab.Constraints/ConstraintBase.cs (modified) (1 diff)

trunk/sources/HeuristicLab.Constraints/ConstraintBase.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.Constraints {
+  /// <summary>
+  /// Base class for all constraints.
+  /// </summary>
   public abstract class ConstraintBase : ItemBase, IConstraint {
+    /// <inheritdoc select="summary"/>
     public virtual string Description {
       get { return "No constraint description available."; }
     }
 
+    /// <summary>
+    /// Checks whether the given data fulfills the current constraint.
+    /// </summary>
+    /// <param name="data">The item to check.</param>
+    /// <returns><c>true</c> if the constraint could be fulfilled, <c>false</c> otherwise.</returns>
     public abstract bool Check(IItem data);
   }