Changeset 1188 for trunk/sources/HeuristicLab.TestFunctions/TestFunctionInjectorView.cs

Timestamp:

01/30/09 10:38:42 (16 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.TestFunctions namespace (#331)

File:

• trunk/sources/HeuristicLab.TestFunctions/TestFunctionInjectorView.cs (modified) (5 diffs)

trunk/sources/HeuristicLab.TestFunctions/TestFunctionInjectorView.cs

@@ -32 +32 @@
 
 namespace HeuristicLab.TestFunctions {
+  /// <summary>
+  /// Visual representation of a <see cref="TestFunctionInjector"/>.
+  /// </summary>
   public partial class TestFunctionInjectorView : ViewBase {
+    /// <summary>
+    /// Gets or sets the TestFunctionInjector to represent visually.
+    /// </summary>
+    /// <remarks>Uses property <see cref="ViewBase.Item"/> of base class <see cref="ViewBase"/>.
+    /// No own data storage present.</remarks>
     public TestFunctionInjector TestFunctionInjector {
       get { return (TestFunctionInjector)base.Item; }
@@ -38 +46 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="TestFunctionInjectorView"/>.
+    /// </summary>
     public TestFunctionInjectorView() {
       InitializeComponent();
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="TestFunctionInjectorView"/> with the given
+    /// <paramref name="testFunctionInjector"/> to display.
+    /// </summary>
+    /// <param name="testFunctionInjector">The injector to represent visually.</param>
     public TestFunctionInjectorView(TestFunctionInjector testFunctionInjector)
       : this() {
@@ -47 +63 @@
     }
 
+    /// <summary>
+    /// Removes the eventhandler from the underlying controls.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.RemoveItemEvents"/> of base class <see cref="ViewBase"/>.
+    /// </remarks>
     protected override void RemoveItemEvents() {
       maximizationCheckBox.DataBindings.Clear();
@@ -55 +76 @@
     }
 
+    /// <summary>
+    /// Adds eventhandlers to the underlying controls.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.AddItemEvents"/> of base class <see cref="ViewBase"/>.
+    /// </remarks>
     protected override void AddItemEvents() {
       base.AddItemEvents();
@@ -63 +89 @@
     }
 
+    /// <summary>
+    /// Updates all controls with the latest values.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.UpdateControls"/> of base class <see cref="ViewBase"/>.</remarks>
     protected override void UpdateControls() {
       base.UpdateControls();