Changeset 1185


Ignore:
Timestamp:
01/28/09 11:53:25 (13 years ago)
Author:
vdorfer
Message:

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

Location:
trunk/sources/HeuristicLab.AdvancedOptimizationFrontend
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • trunk/sources/HeuristicLab.AdvancedOptimizationFrontend/AboutDialog.cs

    r607 r1185  
    2929
    3030namespace HeuristicLab.AdvancedOptimizationFrontend {
     31  /// <summary>
     32  /// The about dialog that presents some basic information about the application.
     33  /// </summary>
    3134  public partial class AboutDialog : Form {
     35    /// <summary>
     36    /// Initializes a new instance of <see cref="AboutDialog"/>.
     37    /// </summary>
    3238    public AboutDialog() {
    3339      InitializeComponent();
  • trunk/sources/HeuristicLab.AdvancedOptimizationFrontend/AvailableOperatorsForm.cs

    r2 r1185  
    3333
    3434namespace HeuristicLab.AdvancedOptimizationFrontend {
     35  /// <summary>
     36  /// Display of all available operators of a specific operator library.
     37  /// </summary>
    3538  public partial class AvailableOperatorsForm : DockContent {
    3639    #region Inner Class TreeNodeSorter
     
    5053    private IOperatorLibrary operatorLibrary;
    5154
     55    /// <summary>
     56    /// Initializes a new instance of <see cref="AvailableOperatorsForm"/>.
     57    /// </summary>
    5258    public AvailableOperatorsForm() {
    5359      InitializeComponent();
  • trunk/sources/HeuristicLab.AdvancedOptimizationFrontend/EditorForm.cs

    r2 r1185  
    3131
    3232namespace HeuristicLab.AdvancedOptimizationFrontend {
     33  /// <summary>
     34  /// Displays the used editor.
     35  /// </summary>
    3336  public partial class EditorForm : DockContent {
    3437    private IEditor myEditor;
     38    /// <summary>
     39    /// Gets the editor that is displayed.
     40    /// </summary>
    3541    public IEditor Editor {
    3642      get { return myEditor; }
    3743    }
    3844
     45    /// <summary>
     46    /// Initializes a new instance of <see cref="EditorForm"/>.
     47    /// </summary>
    3948    public EditorForm() {
    4049      InitializeComponent();
    4150    }
     51    /// <summary>
     52    /// Initializes a new instance of <see cref="EditorForm"/> with the given <paramref name="editor"/>
     53    /// that should be displayed.
     54    /// </summary>
     55    /// <param name="editor">The editor that should be displayed.</param>
    4256    public EditorForm(IEditor editor)
    4357      : this() {
  • trunk/sources/HeuristicLab.AdvancedOptimizationFrontend/HeuristicLabAdvancedOptimizationFrontendApplication.cs

    r593 r1185  
    2727
    2828namespace HeuristicLab.AdvancedOptimizationFrontend {
     29  /// <summary>
     30  /// The HeuristicLab Advanced Optimization Frontend Application.
     31  /// </summary>
    2932  [ClassInfo(Name = "HeuristicLab 3.2 (dockable)", Description="Next generation heuristic optimization environment.")]
    3033  class HeuristicLabAdvancedOptimizationFrontendApplication : ApplicationBase {
     34    /// <summary>
     35    /// Runs the application and displays the main window.
     36    /// </summary>
    3137    public override void Run() {
    3238      Form mainForm = new MainForm();
  • trunk/sources/HeuristicLab.AdvancedOptimizationFrontend/HeuristicLabAdvancedOptimizationFrontendPlugin.cs

    r582 r1185  
    2727
    2828namespace HeuristicLab.AdvancedOptimizationFrontend {
     29  /// <summary>
     30  /// Plugin class for HeuristicLab.AdvancedOptimizationFrontend plugin.
     31  /// </summary>
    2932  [ClassInfo(Name = "HeuristicLab.AdvancedOptimizationFrontend-3.2")]
    3033  [PluginFile(Filename = "HeuristicLab.AdvancedOptimizationFrontend-3.2.dll", Filetype = PluginFileType.Assembly)]
  • trunk/sources/HeuristicLab.AdvancedOptimizationFrontend/MainForm.cs

    r676 r1185  
    3434
    3535namespace HeuristicLab.AdvancedOptimizationFrontend {
     36  /// <summary>
     37  /// The main form of the application.
     38  /// </summary>
    3639  public partial class MainForm : Form, IControlManager {
    3740    #region Inner Types
     
    5356    private int runningTasks;
    5457
     58    /// <summary>
     59    /// Initializes a new instance of <see cref="MainForm"/>.
     60    /// </summary>
    5561    public MainForm() {
    5662      InitializeComponent();
     
    8894
    8995    #region IControlManager Members
     96    /// <summary>
     97    /// Displays the given <paramref name="control"/>.
     98    /// </summary>
     99    /// <exception cref="InvalidOperationException">Thrown when the given <paramref name="control"/>
     100    /// is neither a view nor an editor.</exception>
     101    /// <param name="control">The control to display.</param>
    90102    public void ShowControl(IControl control) {
    91103      DockContent content;
  • trunk/sources/HeuristicLab.AdvancedOptimizationFrontend/ViewForm.cs

    r2 r1185  
    3131
    3232namespace HeuristicLab.AdvancedOptimizationFrontend {
     33  /// <summary>
     34  /// Displays the used view.
     35  /// </summary>
    3336  public partial class ViewForm : DockContent {
    3437    private IView myView;
     38    /// <summary>
     39    /// Gets the view that is displayed.
     40    /// </summary>
    3541    public IView View {
    3642      get { return myView; }
    3743    }
    3844
     45    /// <summary>
     46    /// Initializes a new instance of <see cref="ViewForm"/>.
     47    /// </summary>
    3948    public ViewForm() {
    4049      InitializeComponent();
    4150    }
     51    /// <summary>
     52    /// Initializes a new instance of <see cref="ViewForm"/> with the given <paramref name="view"/>
     53    /// to display.
     54    /// </summary>
     55    /// <param name="view">The view that should be displayed.</param>
    4256    public ViewForm(IView view)
    4357      : this() {
Note: See TracChangeset for help on using the changeset viewer.