Changeset 1185 for trunk/sources/HeuristicLab.AdvancedOptimizationFrontend/MainForm.cs

Timestamp:

01/28/09 11:53:25 (15 years ago)

Author:

vdorfer

Message:

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

File:

• trunk/sources/HeuristicLab.AdvancedOptimizationFrontend/MainForm.cs (modified) (3 diffs)

trunk/sources/HeuristicLab.AdvancedOptimizationFrontend/MainForm.cs

@@ -34 +34 @@
 
 namespace HeuristicLab.AdvancedOptimizationFrontend {
+  /// <summary>
+  /// The main form of the application.
+  /// </summary>
   public partial class MainForm : Form, IControlManager {
     #region Inner Types
@@ -53 +56 @@
     private int runningTasks;
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="MainForm"/>.
+    /// </summary>
     public MainForm() {
       InitializeComponent();
@@ -88 +94 @@
 
     #region IControlManager Members
+    /// <summary>
+    /// Displays the given <paramref name="control"/>. 
+    /// </summary>
+    /// <exception cref="InvalidOperationException">Thrown when the given <paramref name="control"/>
+    /// is neither a view nor an editor.</exception>
+    /// <param name="control">The control to display.</param>
     public void ShowControl(IControl control) {
       DockContent content;