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

trunk/sources/HeuristicLab.Logging/Logger.cs

@@ -28 +28 @@
 
 namespace HeuristicLab.Logging {
+  /// <summary>
+  /// Logs a specified value into a specified log object.
+  /// </summary>
   public class Logger : OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return @"TODO\r\nOperator description still missing ..."; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="Logger"/> with two variable infos 
+    /// (<c>Value</c> and <c>Log</c>).
+    /// </summary>
     public Logger()
       : base() {
@@ -39 +47 @@
     }
 
+    /// <summary>
+    /// Logs a specified value into a specified log object.
+    /// </summary>
+    /// <param name="scope">The current scope.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       ObjectData[] values = new ObjectData[scope.SubScopes.Count];