Changeset 896 for trunk/sources/HeuristicLab.ES/VariableStrengthRepeatingManipulator.cs

Timestamp:

12/04/08 09:01:27 (16 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.ES namespace and changed documentation of some Description properties (#331)

File:

• trunk/sources/HeuristicLab.ES/VariableStrengthRepeatingManipulator.cs (modified) (2 diffs)

trunk/sources/HeuristicLab.ES/VariableStrengthRepeatingManipulator.cs

@@ -29 +29 @@
 
 namespace HeuristicLab.ES {
+  /// <summary>
+  /// Applies its sub operator a number of times depending on the <c>ShakingFactor</c>.
+  /// </summary>
   public class VariableStrengthRepeatingManipulator : OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return @"Applies its suboperator a number of times depending on the ShakingFactor"; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="VariableStrengthRepeatingManipulator"/> with two variable
+    /// infos (<c>Random</c> and <c>ShakingFactor</c>).
+    /// </summary>
     public VariableStrengthRepeatingManipulator()
       : base() {
@@ -40 +48 @@
     }
 
+    /// <summary>
+    /// Applies its suboperator a number of times depending on the <c>ShakingFactor</c>.
+    /// </summary>
+    /// <param name="scope">The current scope where to apply the operator.</param>
+    /// <returns>A new <see cref="CompositeOperation"/>, containing a specified number of 
+    /// the same operations with the same operator, the number depending on the <c>ShakingFactor</c>.</returns>
     public override IOperation Apply(IScope scope) {
       IRandom random = GetVariableValue<IRandom>("Random", scope, true);