Changeset 896 for trunk/sources/HeuristicLab.ES/ESEditor.cs

Timestamp:

12/04/08 09:01:27 (16 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.ES namespace and changed documentation of some Description properties (#331)

File:

• trunk/sources/HeuristicLab.ES/ESEditor.cs (modified) (5 diffs)

trunk/sources/HeuristicLab.ES/ESEditor.cs

@@ -31 +31 @@
 
 namespace HeuristicLab.ES {
+  /// <summary>
+  /// Class for visual representation of an <see cref="ES"/>.
+  /// </summary>
   public partial class ESEditor : EditorBase {
     private ChooseOperatorDialog chooseOperatorDialog;
 
+    /// <summary>
+    /// Gets or sets the evolution strategy to display.
+    /// </summary>
+    /// <remarks>Uses property <see cref="ViewBase.Item"/> of base class <see cref="EditorBase"/>. 
+    /// No own data storage present.</remarks>
     public ES ES {
       get { return (ES)Item; }
@@ -39 +47 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="ESEditor"/>.
+    /// </summary>
     public ESEditor() {
       InitializeComponent();
     }
+    /// <summary>
+    /// Initializes a new instance of <see cref="ESEditor"/> with the given <paramref name="es"/>.
+    /// </summary>
+    /// <param name="es">The evolution strategy to display.</param>
     public ESEditor(ES es)
       : this() {
@@ -47 +62 @@
     }
 
+    /// <summary>
+    /// Removes all event handlers from the underlying <see cref="ES"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.RemoveItemEvents"/> of base class <see cref="EditorBase"/>.</remarks>
     protected override void RemoveItemEvents() {
       ES.Engine.ExceptionOccurred -= new EventHandler<ExceptionEventArgs>(Engine_ExceptionOccurred);
@@ -54 +73 @@
       base.RemoveItemEvents();
     }
+    /// <summary>
+    /// Adds event handlers to the underlying <see cref="ES"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.AddItemEvents"/> of base class <see cref="EditorBase"/>.</remarks>
     protected override void AddItemEvents() {
       base.AddItemEvents();
@@ -72 +95 @@
     }
 
+    /// <summary>
+    /// Updates all controls with the latest data of the model.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.UpdateControls"/> of base class <see cref="EditorBase"/>.</remarks>
     protected override void UpdateControls() {
       base.UpdateControls();