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

trunk/sources/HeuristicLab.Operators/DataCollector.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.Operators {
+  /// <summary>
+  /// Collects values of specific variable names in a given scope.
+  /// </summary>
   public class DataCollector : OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return @"TODO\r\nOperator description still missing ..."; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="DataCollector"/> with two variable infos 
+    /// (<c>VariableNames</c> and <c>Values</c>).
+    /// </summary>
     public DataCollector() {
       IVariableInfo variableNamesVariableInfo = new VariableInfo("VariableNames", "Names of variables whose values should be collected", typeof(ItemList<StringData>), VariableKind.In);
@@ -41 +49 @@
     }
 
+    /// <summary>
+    /// Collects the values of a specified list of variable names in the given <paramref name="scope"/>.
+    /// </summary>
+    /// <param name="scope">The scope where to collect the values from.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       ItemList<StringData> names = GetVariableValue<ItemList<StringData>>("VariableNames", scope, false);