Changeset 801 for trunk/sources/HeuristicLab.Operators/ComparatorBase.cs

Timestamp:

11/21/08 09:48:11 (15 years ago)

Author:

vdorfer

Message:

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

File:

• trunk/sources/HeuristicLab.Operators/ComparatorBase.cs (modified) (3 diffs)

trunk/sources/HeuristicLab.Operators/ComparatorBase.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.Operators {
+  /// <summary>
+  /// Base class for operators which perform comparisons between two items.
+  /// </summary>
   public abstract class ComparatorBase : OperatorBase {
+    /// <summary>
+    /// Initializes a new instance of <see cref="ComparatorBase"/> with three 
+    /// variable infos (<c>LeftSide</c>, <c>RightSide</c> and <c>Result</c>).
+    /// </summary>
     protected ComparatorBase() {
       AddVariableInfo(new VariableInfo("LeftSide", "Variable on the left side of the comparison", typeof(IItem), VariableKind.In));
@@ -34 +41 @@
     }
 
+    /// <summary>
+    /// Compares two items with each other and injects the <c>Result</c> variable - if it is no local one - into
+    /// the specified <paramref name="scope"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="Compare"/>.</remarks>
+    /// <exception cref="InvalidOperationException">Thrown when left side of the comparison does not
+    /// implement <see cref="IComparable"/>.</exception>
+    /// <param name="scope">The scope where to apply the compare operation.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       BoolData result = GetVariableValue<BoolData>("Result", scope, false, false);
@@ -52 +68 @@
     }
 
+    /// <summary>
+    /// Compares two variables with each other.
+    /// </summary>
+    /// <param name="left">The variable on the left side of the comparison.</param>
+    /// <param name="right">The variable on the right side of the comparison.</param>
+    /// <returns><c>true</c> if the comparison query was successful, <c>false</c> otherwise.</returns>
     protected abstract bool Compare(IComparable left, IItem right);
   }