Changeset 801 for trunk/sources/HeuristicLab.Operators/SequentialSubScopesProcessor.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/SequentialSubScopesProcessor.cs (modified) (1 diff)

trunk/sources/HeuristicLab.Operators/SequentialSubScopesProcessor.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.Operators {
+  /// <summary>
+  /// Performs <c>n</c> operators on <c>n</c> subscopes, operations must be executed sequentially.
+  /// </summary>
   public class SequentialSubScopesProcessor : OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return @"TODO\r\nOperator description still missing ..."; }
     }
 
+    /// <summary>
+    /// Applies <c>n</c> operators on all the <c>n</c> sub scopes of the given <paramref name="scope"/>.
+    /// </summary>
+    /// <param name="scope">The scope on whose sub scopes the operators are applied.</param>
+    /// <returns>A new <see cref="CompositeOperation"/> with the <c>i</c>th operator applied
+    /// on the <c>i</c>th sub scope.</returns>
     public override IOperation Apply(IScope scope) {
       CompositeOperation next = new CompositeOperation();