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

Timestamp:

01/22/09 12:06:29 (16 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/PointXYChartView.cs (modified) (6 diffs)

trunk/sources/HeuristicLab.Logging/PointXYChartView.cs

@@ -33 +33 @@
 
 namespace HeuristicLab.Logging {
+  /// <summary>
+  /// Visual representation of a <see cref="PointXYChart"/>.
+  /// </summary>
   public partial class PointXYChartView : ViewBase {
     private static int[] colors = new int[] {
@@ -49 +52 @@
     };
 
+    /// <summary>
+    /// Gets or sets the chart to represent visually.
+    /// </summary>
+    /// <remarks>Uses property <see cref="ViewBase.Item"/> of base class <see cref="ViewBase"/>.
+    /// No own data storage present.</remarks>
     public PointXYChart PointXYChart {
       get { return (PointXYChart)base.Item; }
@@ -54 +62 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="PointXYChartView"/>.
+    /// </summary>
     public PointXYChartView() {
       InitializeComponent();
       Caption = "PointXYChart View";
     }
+    /// <summary>
+    /// Initializes a new instance of <see cref="PointXYChartView"/> with the given 
+    /// <paramref name="pointXYChart"/>.
+    /// </summary>
+    /// <param name="pointXYChart">The chart to represent visually.</param>
     public PointXYChartView(PointXYChart pointXYChart)
       : this() {
@@ -63 +79 @@
     }
 
+    /// <summary>
+    /// Removes the eventhandlers from the underlying <see cref="PointXYChart"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.RemoveItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
     protected override void RemoveItemEvents() {
       if (PointXYChart != null) {
@@ -70 +90 @@
       base.RemoveItemEvents();
     }
+    /// <summary>
+    /// Adds eventhandlers to the underlying <see cref="IOperatorGraph"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.AddItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
     protected override void AddItemEvents() {
       base.AddItemEvents();
@@ -78 +102 @@
     }
 
+    /// <summary>
+    /// Updates all controls with the latest data of the model.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.UpdateControls"/> of base class <see cref="ViewBase"/>.</remarks>
     protected override void UpdateControls() {
       base.UpdateControls();