Changeset 737 for trunk/sources/HeuristicLab.Data/BoolArrayDataView.cs

Timestamp:

11/12/08 13:10:09 (16 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristLab.Data namespace (#331)

File:

• trunk/sources/HeuristicLab.Data/BoolArrayDataView.cs (modified) (3 diffs)

trunk/sources/HeuristicLab.Data/BoolArrayDataView.cs

@@ -29 +29 @@
 
 namespace HeuristicLab.Data {
+  /// <summary>
+  /// The visual representation of the class <see cref="BoolArrayData"/>, 
+  /// symbolizing an array of boolean values.
+  /// </summary>
   public partial class BoolArrayDataView : ArrayDataBaseView {
+    /// <summary>
+    /// Gets or sets the instance of the boolean array to represent visually.
+    /// </summary>
+    /// <remarks>Uses property <see cref="ArrayDataBase"/> of 
+    /// base class <see cref="ArrayDataBaseView"/>. No own data storage present.</remarks>
     public BoolArrayData BoolArrayData {
-      get { return (BoolArrayData)base.Item; }
+      get { return (BoolArrayData)base.ArrayDataBase; }
       set { base.ArrayDataBase = value; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of the class <see cref="BoolArrayDataView"/>.
+    /// </summary>
     public BoolArrayDataView() {
       InitializeComponent();
     }
+    /// <summary>
+    /// Initializes a new instance of the class <see cref="BoolArrayDataView"/> 
+    /// with the given <paramref name="boolArrayData"/>.
+    /// <note type="caution"> No CopyConstructor! <paramref name="boolArrayData"/> is not copied!</note>
+    /// </summary>
+    /// <param name="boolArrayData">The boolean array to represent visually.</param>
     public BoolArrayDataView(BoolArrayData boolArrayData)
       : this() {
@@ -43 +61 @@
     }
 
+    /// <summary>
+    /// Sets the element on position <paramref name="index"/> to the
+    /// given <paramref name="element"/> as boolean value.
+    /// </summary>
+    /// <param name="index">The position where to substitute the element.</param>
+    /// <param name="element">The element to insert.</param>
     protected override void SetArrayElement(int index, string element) {
       bool result;
@@ -50 +74 @@
     }
 
+    /// <summary>
+    /// Checks whether the given <paramref name="element"/> can be converted to a boolean value.
+    /// </summary>
+    /// <param name="element">The data to validate.</param>
+    /// <returns><c>true</c> if the <paramref name="element"/> could be converted,
+    /// <c>false</c> otherwise.</returns>
     protected override bool ValidateData(string element) {
       bool result;