Changeset 1179 for trunk/sources/HeuristicLab.Evolutionary

Timestamp:

01/27/09 13:42:30 (16 years ago)

Author:

abeham

Message:

added documentation to ChildrenInitializer

File:

• trunk/sources/HeuristicLab.Evolutionary/ChildrenInitializer.cs (modified) (3 diffs)

trunk/sources/HeuristicLab.Evolutionary/ChildrenInitializer.cs

@@ -28 +28 @@
 
 namespace HeuristicLab.Evolutionary {
+  /// <summary>
+  /// Initializes and prepares the children for crossover
+  /// </summary>
   public class ChildrenInitializer : OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get {
@@ -35 +39 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="ChildrenInitializer"/> with one variable info: <c>ParentsPerChild</c>.
+    /// </summary>
     public ChildrenInitializer()
       : base() {
@@ -42 +49 @@
     }
 
+    /// <summary>
+    /// Initializes the children as new scopes and inserts their parents as subscopes.
+    /// </summary>
+    /// <exception cref="InvalidOperationException">Thrown when the number of selected parents is not a natural multiple of <c>ParentsPerChild</c>.</exception>
+    /// <param name="scope">The scope that houses all the selected parents as subscopes.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       int parents = GetVariableValue<IntData>("ParentsPerChild", scope, true).Data;