Changeset 737 for trunk/sources/HeuristicLab.Data/DoubleDataView.cs

Timestamp:

11/12/08 13:10:09 (16 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristLab.Data namespace (#331)

File:

• trunk/sources/HeuristicLab.Data/DoubleDataView.cs (modified) (4 diffs)

trunk/sources/HeuristicLab.Data/DoubleDataView.cs

@@ -30 +30 @@
 
 namespace HeuristicLab.Data {
+  /// <summary>
+  /// The visual representation of the class <see cref="DoubleData"/>, symbolizing a double value.
+  /// </summary>
   public partial class DoubleDataView : ViewBase {
+    /// <summary>
+    /// Gets or sets the double value to represent visually.
+    /// </summary>
+    /// <remarks>Uses property <see cref="HeuristicLab.Core.ViewBase.Item"/> of base class 
+    /// <see cref="ViewBase"/>. No own data storage present.</remarks>
     public DoubleData DoubleData {
       get { return (DoubleData)Item; }
@@ -36 +44 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of the class <see cref="DoubleDataView"/>.
+    /// </summary>
     public DoubleDataView() {
       InitializeComponent();
     }
+    /// <summary>
+    /// Initializes a new instance of the class <see cref="DoubleDataView"/> with the given 
+    /// <paramref name="doubleData"/>.
+    /// <note type="caution"> No CopyConstructor! <paramref name="doubleData"/> is not copied!</note>
+    /// </summary>
+    /// <param name="doubleData">The double value to represent visually.</param>
     public DoubleDataView(DoubleData doubleData)
       : this() {
@@ -44 +61 @@
     }
 
+    /// <summary>
+    /// Removes the eventhandler from the underlying <see cref="DoubleData"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="HeuristicLab.Core.ViewBase.RemoveItemEvents"/> of base class <see cref="ViewBase"/>.
+    /// </remarks>
     protected override void RemoveItemEvents() {
       DoubleData.Changed -= new EventHandler(DoubleData_Changed);
       base.RemoveItemEvents();
     }
+    /// <summary>
+    /// Adds an eventhandler to the underlying <see cref="DoubleData"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="HeuristicLab.Core.ViewBase.AddItemEvents"/> of base class <see cref="ViewBase"/>.
+    /// </remarks>
     protected override void AddItemEvents() {
       base.AddItemEvents();
@@ -53 +80 @@
     }
 
+    /// <summary>
+    /// Updates the controls with the latest double value.
+    /// </summary>
     protected override void UpdateControls() {
       base.UpdateControls();