Changeset 1176 for trunk/sources/HeuristicLab.Constraints/AndConstraintView.cs

Timestamp:

01/27/09 09:31:06 (15 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.BitVector and HeuristicLab.Constraints namespace and changed a comment in HeuristicLab.IntVector namespace(#331)

File:

• trunk/sources/HeuristicLab.Constraints/AndConstraintView.cs (modified) (4 diffs)

trunk/sources/HeuristicLab.Constraints/AndConstraintView.cs

@@ -31 +31 @@
 
 namespace HeuristicLab.Constraints {
+  /// <summary>
+  /// The visual representation of an <see cref="AndConstraint"/>.
+  /// </summary>
   public partial class AndConstraintView : ViewBase {
+    /// <summary>
+    /// Gets or sets the AndConstraint to represent visually.
+    /// </summary>
+    /// <remarks>Uses property <see cref="ViewBase.Item"/> of base class <see cref="ViewBase"/>.</remarks>
+    /// No own data storage present. 
     public AndConstraint AndConstraint {
       get { return (AndConstraint)Item; }
@@ -37 +45 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="AndConstraintView"/>.
+    /// </summary>
     public AndConstraintView() {
       InitializeComponent();
     }
+    /// <summary>
+    /// Initializes a new instance of <see cref="AndConstraintView"/> with the given 
+    /// <paramref name="andConstraint"/> to display.
+    /// </summary>
+    /// <param name="andConstraint">The constraint to represent visually.</param>
     public AndConstraintView(AndConstraint andConstraint)
       : this() {
@@ -45 +61 @@
     }
 
+    /// <summary>
+    /// Removes the eventhandler from the underlying <see cref="AndConstraint"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.RemoveItemEvents"/> of base class <see cref="ViewBase"/>.
+    /// </remarks>
     protected override void RemoveItemEvents() {
       AndConstraint.Changed -= new EventHandler(AndConstraint_Changed);
       base.RemoveItemEvents();
     }
+    /// <summary>
+    /// Adds an eventhandler to the underlying <see cref="AndConstraint"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.AddItemEvents"/> of base class <see cref="ViewBase"/>.
+    /// </remarks>
     protected override void AddItemEvents() {
       base.AddItemEvents();
@@ -54 +80 @@
     }
 
+    /// <summary>
+    /// Updates all controls with the latest values.
+    /// </summary>
     protected override void UpdateControls() {
       if (AndConstraint == null) {