Changeset 1153 for trunk/sources/HeuristicLab.Random/RandomInjector.cs

Timestamp:

01/16/09 11:24:03 (16 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.Random, HeuristicLab.SGA and HeuristicLab.Selection.OffspringSelection namespace (#331)

File:

• trunk/sources/HeuristicLab.Random/RandomInjector.cs (modified) (2 diffs)

trunk/sources/HeuristicLab.Random/RandomInjector.cs

@@ -29 +29 @@
 
 namespace HeuristicLab.Random {
+  /// <summary>
+  /// Injects a random variable in a given scope.
+  /// </summary>
   public class RandomInjector : OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return @"TODO\r\nOperator description still missing ..."; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="RandomInjector"/> with three variable infos
+    /// (<c>SetSeedRandomly</c>, <c>Seed</c> and <c>Random</c>.)
+    /// </summary>
     public RandomInjector()
       : base() {
@@ -48 +56 @@
     }
 
+    /// <summary>
+    /// Injects a new random variable in the given <paramref name="scope"/> .
+    /// </summary>
+    /// <param name="scope">The scope where to inject the variable.</param>
+    /// <returns>null.</returns>
     public override IOperation Apply(IScope scope) {
       bool setRandomly = GetVariableValue<BoolData>("SetSeedRandomly", scope, true).Data;