Changeset 801 for trunk/sources/HeuristicLab.Operators/CombinedOperatorView.cs

Timestamp:

11/21/08 09:48:11 (16 years ago)

Author:

vdorfer

Message:

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

File:

• trunk/sources/HeuristicLab.Operators/CombinedOperatorView.cs (modified) (5 diffs)

trunk/sources/HeuristicLab.Operators/CombinedOperatorView.cs

@@ -30 +30 @@
 
 namespace HeuristicLab.Operators {
+  /// <summary>
+  /// The visual representation of a <see cref="CombinedOperator"/>.
+  /// </summary>
   public partial class CombinedOperatorView : ViewBase {
+    /// <summary>
+    /// Gets or sets the combined operator to display.
+    /// </summary>
+    /// <remarks>Uses property <see cref="ViewBase.Item"/> of base class <see cref="ViewBase"/>.
+    /// No own data storage present.</remarks>
     public CombinedOperator CombinedOperator {
       get { return (CombinedOperator)Item; }
@@ -36 +44 @@
     }
 
+    /// <summary>
+    /// Removes the eventhandlers in all children and from the underlying <see cref="CombinedOperator"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.RemoveItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
     protected override void RemoveItemEvents() {
       operatorGraphView.OperatorGraph = null;
@@ -44 +56 @@
       base.RemoveItemEvents();
     }
-
+    
+    /// <summary>
+    /// Adds event handlers in all children and to the underlying <see cref="CombinedOperator"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.AddItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
     protected override void AddItemEvents() {
       base.AddItemEvents();
@@ -54 +70 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="CombinedOperatorView"/>.
+    /// </summary>
     public CombinedOperatorView() {
       InitializeComponent();
     }
+    /// <summary>
+    /// Initializes a new instance of <see cref="CombinedOperatorView"/> with the specified 
+    /// <paramref name="combinedOperator"/>.
+    /// </summary>
+    /// <param name="combinedOperator">The combined operator to display.</param>
     public CombinedOperatorView(CombinedOperator combinedOperator)
       : this() {
@@ -62 +86 @@
     }
 
+    /// <summary>
+    /// Updates all controls with the latest data of the model.
+    /// </summary>
     protected override void UpdateControls() {
       base.UpdateControls();