Changeset 1186 for trunk/sources/HeuristicLab.ThreadParallelEngine/ThreadParallelEngineEditor.cs

Timestamp:

01/29/09 14:03:34 (15 years ago)

Author:

vdorfer

Message:

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

File:

• trunk/sources/HeuristicLab.ThreadParallelEngine/ThreadParallelEngineEditor.cs (modified) (5 diffs)

trunk/sources/HeuristicLab.ThreadParallelEngine/ThreadParallelEngineEditor.cs

@@ -30 +30 @@
 
 namespace HeuristicLab.ThreadParallelEngine {
+  /// <summary>
+  /// Visual representation of a <see cref="ThreadParallelEngine"/>.
+  /// </summary>
   public partial class ThreadParallelEngineEditor : EngineBaseEditor {
+    /// <summary>
+    /// Gets or sets the ThreadParallelEngine to display.
+    /// </summary>
+    /// <remarks>Uses property <see cref="EngineBaseEditor.Engine"/> of base class 
+    /// <see cref="EngineBaseEditor"/>. No own data storage present.</remarks>
     public ThreadParallelEngine ThreadParallelEngine {
       get { return (ThreadParallelEngine)Engine; }
@@ -36 +44 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="ThreadParallelEngineEditor"/>.
+    /// </summary>
     public ThreadParallelEngineEditor() {
       InitializeComponent();
     }
+    /// <summary>
+    /// Initializes a new instance of <see cref="ThreadParallelEngineEditor"/> with the given
+    /// <paramref name="threadParallelEngine"/> to display.
+    /// </summary>
+    /// <param name="threadParallelEngine">The engine to represent visually.</param>
     public ThreadParallelEngineEditor(ThreadParallelEngine threadParallelEngine)
       : this() {
@@ -44 +60 @@
     }
 
+    /// <summary>
+    /// Removes the eventhandlers from the underlying <see cref="ThreadParallelEngine"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="EngineBaseEditor.RemoveItemEvents"/> of base class 
+    /// <see cref="EngineBaseEditor"/>.
+    /// </remarks>
     protected override void RemoveItemEvents() {
       ThreadParallelEngine.WorkersChanged -= new EventHandler(ThreadParallelEngine_WorkersChanged);
@@ -49 +71 @@
     }
 
+    /// <summary>
+    /// Adds eventhandlers to the underlying <see cref="ThreadParallelEngine"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="EngineBaseEditor.AddItemEvents"/> of base class 
+    /// <see cref="EngineBaseEditor"/>.
+    /// </remarks>
     protected override void AddItemEvents() {
       base.AddItemEvents();
@@ -54 +82 @@
     }
 
+    /// <summary>
+    /// Updates the controls with the latest data.
+    /// </summary>
+    /// <remarks>Calls <see cref="EngineBaseEditor.UpdateControls"/> of base class 
+    /// <see cref="EngineBaseEditor"/>.</remarks>
     protected override void UpdateControls() {
       base.UpdateControls();