Changeset 737 for trunk/sources/HeuristicLab.Data/ObjectData.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/ObjectData.cs (modified) (6 diffs)

trunk/sources/HeuristicLab.Data/ObjectData.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.Data {
+  /// <summary>
+  /// Represents the base class for all base data types.
+  /// </summary>
   public class ObjectData : ItemBase, IObjectData {
     private object myData;
+    /// <summary>
+    /// Gets or sets the data to represent.
+    /// </summary>
+    /// <remarks>Calls <see cref="HeuristicLab.Core.ItemBase.OnChanged"/>.</remarks>
     public virtual object Data {
       get { return myData; }
@@ -39 +46 @@
     }
 
+    /// <summary>
+    /// Clones the current instance.
+    /// </summary>
+    /// <remarks>HeuristicLab data items are cloned with the <see cref="HeuristicLab.Core.Auxiliary.Clone"/> method of 
+    /// class <see cref="Auxiliary"/> (deep copy), all other items (like basic data types) 
+    /// are cloned with their own <c>Clone</c> methods (shadow copy).</remarks>
+    /// <exception cref="InvalidOperationException">Thrown when the current instance is not cloneable.</exception>
+    /// <param name="clonedObjects">A dictionary of all already cloned objects.</param>
+    /// <returns>The clone instance.</returns>
     public override object Clone(IDictionary<Guid, object> clonedObjects) {
       ObjectData clone = (ObjectData)base.Clone(clonedObjects);
@@ -50 +66 @@
     }
 
+    /// <summary>
+    /// Checks whether the current instance equals the specified <paramref name="obj"/>.
+    /// </summary>
+    /// <param name="obj">The object to compare with.</param>
+    /// <returns><c>true</c>, if both objects are the same or 
+    /// the contained data is the same, <c>false</c> otherwise.</returns>
     public override bool Equals(object obj) {
       if(obj == this) return true; // same instance
@@ -59 +81 @@
     }
 
+    /// <inheritdoc cref="object.GetHashCode"/>
     public override int GetHashCode() {
       return Data.GetHashCode();
     }
 
+    /// <summary>
+    /// Compares the current instance to the given <paramref name="obj"/>.
+    /// </summary>
+    /// <remarks>Can also compare basic data types with their representing HeuristicLab data types 
+    /// (e.g. a <see cref="BoolData"/> with a boolean value).</remarks>
+    /// <exception cref="InvalidOperationException">Thrown when the current 
+    /// instance does not implement the interface <see cref="IComparable"/></exception>
+    /// <param name="obj">The object to compare the current instance to.</param>
+    /// <returns><c>0</c> if the objects are the same, a value smaller than zero when the current instance
+    /// is smaller than the given <paramref name="obj"/> and a value greater than zero 
+    /// when the current instance is greater than the given <paramref name="obj"/>.</returns>
     public int CompareTo(object obj) {
       IComparable comparable = Data as IComparable;
@@ -75 +109 @@
     }
 
+    /// <summary>
+    /// The string representation of the current instance.
+    /// </summary>
+    /// <returns>"null" if property <see cref="Data"/> is <c>null</c>, else 
+    /// the string representation of the current instance.</returns>
     public override string ToString() {
       if (Data == null)
@@ -82 +121 @@
     }
 
+    /// <summary>
+    /// The point of intersection where an <see cref="IObjectDataVisitor"/> 
+    /// can change the object.
+    /// </summary>
+    /// <param name="visitor">The visitor that changes the element.</param>
     public virtual void Accept(IObjectDataVisitor visitor) {
       visitor.Visit(this);