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

Timestamp:

01/22/09 12:06:29 (15 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/LogView.cs (modified) (5 diffs)

trunk/sources/HeuristicLab.Logging/LogView.cs

@@ -31 +31 @@
 
 namespace HeuristicLab.Logging {
+  /// <summary>
+  /// Visual representation of the <see cref="Log"/> class.
+  /// </summary>
   public partial class LogView : ViewBase {
+    /// <summary>
+    /// Gets or sets the Log item to represent visually.
+    /// </summary>
+    /// <remarks>Uses property <see cref="ViewBase.Item"/> of base class <see cref="ViewBase"/>.
+    /// No own data storage present.</remarks>
     public Log Log {
       get { return (Log)base.Item; }
@@ -37 +45 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="LogView"/>.
+    /// </summary>
     public LogView() {
       InitializeComponent();
       Caption = "Log View";
     }
+    /// <summary>
+    /// Initializes a new instance of <see cref="LogView"/> with the given <paramref name="log"/>.
+    /// </summary>
+    /// <param name="log">The log object to represent visually.</param>
     public LogView(Log log)
       : this() {
@@ -46 +61 @@
     }
 
+    /// <summary>
+    /// Removes the event handlers from the underlying <see cref="Log"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.RemoveItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
     protected override void RemoveItemEvents() {
       if (Log != null) {
@@ -53 +72 @@
       base.RemoveItemEvents();
     }
+    /// <summary>
+    /// Adds event handlers to the underlying <see cref="Log"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.AddItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
     protected override void AddItemEvents() {
       base.AddItemEvents();
@@ -61 +84 @@
     }
 
+    /// <summary>
+    /// Updates all controls with the latest data of the model.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.UpdateControls"/> of base class 
+    /// <see cref="UpdateControls"/>.</remarks>
     protected override void UpdateControls() {
       base.UpdateControls();