Changeset 776 for trunk/sources/HeuristicLab.Core/ChooseTypeDialog.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/ChooseTypeDialog.cs (modified) (3 diffs)

trunk/sources/HeuristicLab.Core/ChooseTypeDialog.cs

@@ -31 +31 @@
 
 namespace HeuristicLab.Core {
+  /// <summary>
+  /// A dialog to select a specific type.
+  /// </summary>
   public partial class ChooseTypeDialog : Form {
     #region Inner Class TreeNodeSorter
@@ -46 +49 @@
     #endregion
 
+    /// <summary>
+    /// Gets or sets the caption of the dialog.
+    /// </summary>
+    /// <remarks>Uses property <see cref="Form.Text"/> of base class <see cref="Form"/>.
+    /// No own data storage present.</remarks>
     public string Caption {
       get { return Text; }
@@ -52 +60 @@
 
     private Type myType;
+    /// <summary>
+    /// Gets the selected type.
+    /// </summary>
     public Type Type {
       get { return myType; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="ChooseTypeDialog"/>.
+    /// </summary>
+    /// <remarks>Calls <see cref="ChooseTypeDialog(Type)"/> with the type of <see cref="IItem"/> as
+    /// parameter.</remarks>
     public ChooseTypeDialog()
       : this(typeof(IItem)) {
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="ChooseTypeDialog"/> with the given 
+    /// <paramref name="baseType"/>.
+    /// </summary>
+    /// <param name="baseType">The base type of all chooseable types.</param>
     public ChooseTypeDialog(Type baseType) {
       InitializeComponent();