Changeset 884 for trunk/sources/HeuristicLab.Routing.TSP/TSPInjectorView.cs

Timestamp:

12/02/08 12:41:21 (15 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.Routing.TSP namespace (#331)

File:

• trunk/sources/HeuristicLab.Routing.TSP/TSPInjectorView.cs (modified) (5 diffs)

trunk/sources/HeuristicLab.Routing.TSP/TSPInjectorView.cs

@@ -32 +32 @@
 
 namespace HeuristicLab.Routing.TSP {
+  /// <summary>
+  /// Class to represent a <see cref="TSPInjector"/> visually.
+  /// </summary>
   public partial class TSPInjectorView : ViewBase {
+    /// <summary>
+    /// Gets or set the <see cref="TSPInjector"/> to represent visually.
+    /// </summary>        
+    /// <remarks>Uses property <see cref="ViewBase.Item"/> of base class <see cref="ViewBase"/>.
+    /// No own data storage present.</remarks>
     public TSPInjector TSPInjector {
       get { return (TSPInjector)Item; }
@@ -38 +46 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="TSPInjectorView"/>.
+    /// </summary>
     public TSPInjectorView() {
       InitializeComponent();
     }
+    /// <summary>
+    /// Initializes a new instance of <see cref="TSPInjectorView"/> with the given 
+    /// <paramref name="tspInjector"/>.
+    /// </summary>
+    /// <param name="tspInjector">The <see cref="TSPInjector"/> to display.</param>
     public TSPInjectorView(TSPInjector tspInjector)
       : this() {
@@ -46 +62 @@
     }
 
+    /// <summary>
+    /// Removes the event handlers in all children.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.RemoveItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
     protected override void RemoveItemEvents() {
       operatorBaseVariableInfosView.Operator = null;
@@ -51 +71 @@
       base.RemoveItemEvents();
     }
+    /// <summary>
+    /// Adds event handlers in all children.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.AddItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
     protected override void AddItemEvents() {
       base.AddItemEvents();
@@ -57 +81 @@
     }
 
+    /// <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();