Changeset 801 for trunk/sources/HeuristicLab.Operators/OperatorExtractor.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/OperatorExtractor.cs (modified) (3 diffs)

trunk/sources/HeuristicLab.Operators/OperatorExtractor.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.Operators {
+  /// <summary>
+  /// Retrieves an operator from a specified scope and returns a successor operation with this operation
+  /// and scope.
+  /// </summary>
   public class OperatorExtractor : OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return @"An operator extractor retrievs an operator from the scope it is applied on and returns a successor operation containing this operator and the current scope. Lookup for the operator is done recursively.
@@ -34 +39 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="OperatorExtractor"/> with 
+    /// one variable info (<c>Operator</c>).
+    /// </summary>
     public OperatorExtractor()
       : base() {
@@ -39 +48 @@
     }
 
+    /// <summary>
+    /// Gets an operator from the specified <paramref name="scope"/> and returns an 
+    /// <see cref="AtomicOperation"/> containing this operator and scope.
+    /// </summary>
+    /// <param name="scope">The scope where to apply the operator on.</param>
+    /// <returns>A new <see cref="AtomicOperation"/> containing the operator and the given
+    /// <paramref name="scope"/>.</returns>
     public override IOperation Apply(IScope scope) {
       IOperator op = GetVariableValue<IOperator>("Operator", scope, true, true);