Context Navigation

Changeset 1185

Timestamp:

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

Author:

vdorfer

Message:

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

Location:

trunk/sources/HeuristicLab.AdvancedOptimizationFrontend

Files:

-                      r607
+                      r1185
 namespace HeuristicLab.AdvancedOptimizationFrontend {
+  /// <summary>
+  /// The about dialog that presents some basic information about the application.
+  /// </summary>
   public partial class AboutDialog : Form {
+    /// <summary>
+    /// Initializes a new instance of <see cref="AboutDialog"/>.
+    /// </summary>
     public AboutDialog() {
       InitializeComponent();

-                      r2
+                      r1185
 namespace HeuristicLab.AdvancedOptimizationFrontend {
+  /// <summary>
+  /// Display of all available operators of a specific operator library.
+  /// </summary>
   public partial class AvailableOperatorsForm : DockContent {
     #region Inner Class TreeNodeSorter
 …
     private IOperatorLibrary operatorLibrary;
+    /// <summary>
+    /// Initializes a new instance of <see cref="AvailableOperatorsForm"/>.
+    /// </summary>
     public AvailableOperatorsForm() {
       InitializeComponent();

-                      r2
+                      r1185
 namespace HeuristicLab.AdvancedOptimizationFrontend {
+  /// <summary>
+  /// Displays the used editor.
+  /// </summary>
   public partial class EditorForm : DockContent {
     private IEditor myEditor;
+    /// <summary>
+    /// Gets the editor that is displayed.
+    /// </summary>
     public IEditor Editor {
       get { return myEditor; }
+    }
+    /// <summary>
+    /// Initializes a new instance of <see cref="EditorForm"/>.
+    /// </summary>
     public EditorForm() {
       InitializeComponent();
+    }
+    /// <summary>
+    /// Initializes a new instance of <see cref="EditorForm"/> with the given <paramref name="editor"/>
+    /// that should be displayed.
+    /// </summary>
+    /// <param name="editor">The editor that should be displayed.</param>
     public EditorForm(IEditor editor)
       : this() {

-                      r593
+                      r1185
 namespace HeuristicLab.AdvancedOptimizationFrontend {
+  /// <summary>
+  /// The HeuristicLab Advanced Optimization Frontend Application.
+  /// </summary>
   [ClassInfo(Name = "HeuristicLab 3.2 (dockable)", Description="Next generation heuristic optimization environment.")]
   class HeuristicLabAdvancedOptimizationFrontendApplication : ApplicationBase {
+    /// <summary>
+    /// Runs the application and displays the main window.
+    /// </summary>
     public override void Run() {
       Form mainForm = new MainForm();

-                      r582
+                      r1185
 namespace HeuristicLab.AdvancedOptimizationFrontend {
+  /// <summary>
+  /// Plugin class for HeuristicLab.AdvancedOptimizationFrontend plugin.
+  /// </summary>
   [ClassInfo(Name = "HeuristicLab.AdvancedOptimizationFrontend-3.2")]
   [PluginFile(Filename = "HeuristicLab.AdvancedOptimizationFrontend-3.2.dll", Filetype = PluginFileType.Assembly)]

-                      r676
+                      r1185
 namespace HeuristicLab.AdvancedOptimizationFrontend {
+  /// <summary>
+  /// The main form of the application.
+  /// </summary>
   public partial class MainForm : Form, IControlManager {
     #region Inner Types
 …
     private int runningTasks;
+    /// <summary>
+    /// Initializes a new instance of <see cref="MainForm"/>.
+    /// </summary>
     public MainForm() {
       InitializeComponent();
 …
     #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;

-                      r2
+                      r1185
 namespace HeuristicLab.AdvancedOptimizationFrontend {
+  /// <summary>
+  /// Displays the used view.
+  /// </summary>
   public partial class ViewForm : DockContent {
     private IView myView;
+    /// <summary>
+    /// Gets the view that is displayed.
+    /// </summary>
     public IView View {
       get { return myView; }
+    }
+    /// <summary>
+    /// Initializes a new instance of <see cref="ViewForm"/>.
+    /// </summary>
     public ViewForm() {
       InitializeComponent();
+    }
+    /// <summary>
+    /// Initializes a new instance of <see cref="ViewForm"/> with the given <paramref name="view"/>
+    /// to display.
+    /// </summary>
+    /// <param name="view">The view that should be displayed.</param>
     public ViewForm(IView view)
       : this() {

Note: See TracChangeset for help on using the changeset viewer.