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

trunk/sources/HeuristicLab.Operators.Metaprogramming/PermutationInjector.cs

@@ -28 +28 @@
 
 namespace HeuristicLab.Operators.Metaprogramming {
+  /// <summary>
+  /// Injects a new permutation variable in the given scope. The number of items contained
+  /// are in a predifined range.
+  /// </summary>
   public class PermutationInjector : OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return "TASK."; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="PermutationInjector"/> with five variable infos
+    /// (<c>VariableInjector</c>, <c>VariableName</c>, <c>Items</c>, <c>Min</c> and <c>Max</c>).
+    /// </summary>
     public PermutationInjector()
       : base() {
@@ -42 +51 @@
     }
 
+    /// <summary>
+    /// Injects a new permutation variable into the given <paramref name="scope"/>.
+    /// </summary>
+    /// <param name="scope">The current scope where to inject the permutation list.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       int min = GetVariableValue<IntData>("Min", scope, true).Data;