Changeset 1167 for trunk/sources/HeuristicLab.Logging/PointXYChartInjector.cs

Timestamp:

01/22/09 12:06:29 (15 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.Operators.Metaprogramming and HeuristicLab.Logging namespace and changed a comment in HeuristicLab.Core namespace(#331)

File:

• trunk/sources/HeuristicLab.Logging/PointXYChartInjector.cs (modified) (2 diffs)

trunk/sources/HeuristicLab.Logging/PointXYChartInjector.cs

@@ -28 +28 @@
 
 namespace HeuristicLab.Logging {
+  /// <summary>
+  /// Injects a new PointXYChart variable into the given scope.
+  /// </summary>
   class PointXYChartInjector : OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return @"TODO\r\nOperator description still missing ..."; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="PointXYChartInjector"/> with three variable infos
+    /// (<c>ConnectDots</c>, <c>Values</c> and <c>PointXYChart</c>).
+    /// </summary>
     public PointXYChartInjector() {
       VariableInfo connectDotsInfo = new VariableInfo("ConnectDots", "Number of lines the linechart consists of", typeof(BoolData), VariableKind.In);
@@ -42 +50 @@
     }
 
+    /// <summary>
+    /// Injects a new PointXYChart variable into the given <paramref name="scope"/>.
+    /// </summary>
+    /// <param name="scope">The current scope where to inject the variable.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       bool connectDots = GetVariableValue<BoolData>("ConnectDots", scope, true).Data;