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

Timestamp:

01/22/09 12:06:29 (16 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/BestSolutionStorer.cs (modified) (2 diffs)

trunk/sources/HeuristicLab.Logging/BestSolutionStorer.cs

@@ -28 +28 @@
 
 namespace HeuristicLab.Logging {
+  /// <summary>
+  /// Keeps a variable in the global scope that contains the scope representing the best solution.
+  /// </summary>
   public class BestSolutionStorer : DelegatingOperator {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return @"Keeps a variable in the global scope that contains the scope representing the best of run solution."; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="BestSolutionStorer"/> with three variable infos
+    /// (<c>Quality</c>, <c>Maximization</c> and <c>BestSolution</c>).
+    /// </summary>
     public BestSolutionStorer()
       : base() {
@@ -40 +48 @@
     }
 
+    /// <summary>
+    /// Keeps a variable in the global scope that contains the scope representing the best solution.
+    /// </summary>
+    /// <param name="scope">The scope whose populations to check for the best solution.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       if(scope.GetVariable(Guid.ToString() + "-Active") == null) {