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

Timestamp:

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

Author:

vdorfer

Message:

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

File:

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

trunk/sources/HeuristicLab.Operators/ConditionalBranch.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.Operators {
+  /// <summary>
+  /// Branch of (one or)two operators whose executions depend on a specific condition.
+  /// </summary>
   public class ConditionalBranch : OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return @"ConditionalBranch expects to have 1 or 2 sub-operators.
@@ -35 +39 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="ConditionalBranch"/> with one variable info 
+    /// (<c>Condition</c>).
+    /// </summary>
     public ConditionalBranch()
       : base() {
@@ -40 +48 @@
     }
 
+    /// <summary>
+    /// Applies the operator of branch one under a specific condition on the given 
+    /// <paramref name="scope"/>, or - if existent - operator of branch two if the condition could not
+    /// be fulfilled. 
+    /// </summary>
+    /// <param name="scope">The scope to apply the operators on.</param>
+    /// <returns>A new <see cref="AtomicOperation"/> with either operator 1 or operator 2 applied
+    /// to the given <paramref name="scope"/> or <c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       BoolData resultData = GetVariableValue<BoolData>("Condition", scope, true);