Changeset 776 for trunk/sources/HeuristicLab.Core/EditorBase.cs

Timestamp:

11/19/08 12:12:39 (16 years ago)

Author:

vdorfer

Message:

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

File:

• trunk/sources/HeuristicLab.Core/EditorBase.cs (modified) (4 diffs)

trunk/sources/HeuristicLab.Core/EditorBase.cs

@@ -29 +29 @@
 
 namespace HeuristicLab.Core {
+  /// <summary>
+  /// Base class for views that can load and save data.
+  /// </summary>
   public partial class EditorBase : ViewBase, IEditor {
     private string myFilename;
+    /// <summary>
+    /// Gets or sets the filename of the current editor.
+    /// </summary>
+    /// <remarks>Calls <see cref="OnFilenameChanged"/> in the setter if the filename is new.</remarks>
     public string Filename {
       get { return myFilename; }
@@ -41 +48 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="EditorBase"/> with the caption "Editor".
+    /// </summary>
     public EditorBase() {
       InitializeComponent();
@@ -46 +56 @@
     }
 
+    /// <summary>
+    /// Updates all controls with the latest data of the model.
+    /// </summary>
+    /// <remarks>Calls <see cref="ViewBase.UpdateControls"/> of base class <see cref="ViewBase"/>.</remarks>
     protected override void UpdateControls() {
       base.UpdateControls();
@@ -54 +68 @@
     }
 
+    /// <summary>
+    /// Occurs when the filename is changed.
+    /// </summary>
     public event EventHandler FilenameChanged;
+    /// <summary>
+    /// Fires a new <c>FilenameChanged</c> event.
+    /// </summary>
     protected virtual void OnFilenameChanged() {
       if (FilenameChanged != null)