Changeset 3016 for trunk/sources/HeuristicLab.Persistence/3.3/Default/CompositeSerializers/Storable/DataMemberAccessor.cs

Timestamp:

03/14/10 00:42:28 (15 years ago)

Author:

epitzer

Message:

Update API docs. (#548)

File:

• trunk/sources/HeuristicLab.Persistence/3.3/Default/CompositeSerializers/Storable/DataMemberAccessor.cs (modified) (5 diffs)

trunk/sources/HeuristicLab.Persistence/3.3/Default/CompositeSerializers/Storable/DataMemberAccessor.cs

@@ -12 +12 @@
   public class DataMemberAccessor {
 
+    /// <summary>
+    /// The function to get the value of the data member.
+    /// </summary>
     public readonly Func<object> Get;
+
+    /// <summary>
+    /// The function to set the value of the data member.
+    /// </summary>
     public readonly Action<object> Set;
+
+    /// <summary>
+    /// The name of the data member.
+    /// </summary>
     public readonly string Name;
+
+    /// <summary>
+    /// The default value of the data member, can remain <c>null</c>
+    /// if no default value. If left null, this will also leave the
+    /// default value for value types (e.g. 0 for <c>int</c>).
+    /// </summary>
     public readonly object DefaultValue;
 
 
     /// <summary>
-    /// Create a DataMemberAccessor from a FieldInfo or PropertyInfo for the give object.
+    /// Create a <see cref="DataMemberAccessor"/> from a FieldInfo or
+    /// PropertyInfo for the give object.
     /// </summary>
+    /// <param name="memberInfo">The member info.</param>
+    /// <param name="name">The name.</param>
+    /// <param name="defaultvalue">The defaultvalue.</param>
+    /// <param name="obj">The object.</param>
     public DataMemberAccessor(MemberInfo memberInfo, string name, object defaultvalue, object obj) {
       Name = name;
@@ -45 +67 @@
     /// Wrap existing getter and setter functions.
     /// </summary>
+    /// <param name="name">The name.</param>
+    /// <param name="defaultValue">The default value.</param>
+    /// <param name="getter">The getter.</param>
+    /// <param name="setter">The setter.</param>
     public DataMemberAccessor(string name, object defaultValue,
         Func<object> getter, Action<object> setter) {
@@ -52 +78 @@
       Set = setter;
     }
-    
+
     /// <summary>
     /// Create an empty accessor that just encapsulates an object
     /// without access.
     /// </summary>
+    /// <param name="o">The object</param>
     public DataMemberAccessor(object o) {
       Name = null;
@@ -68 +95 @@
     /// without access.
     /// </summary>
+    /// <param name="o">The object</param>
+    /// <param name="name">The object's name.</param>
     public DataMemberAccessor(object o, string name) {
       Name = name;
@@ -75 +104 @@
     }
 
+    /// <summary>
+    /// Returns a <see cref="System.String"/> that represents this instance.
+    /// </summary>
+    /// <returns>
+    /// A <see cref="System.String"/> that represents this instance.
+    /// </returns>
     public override string ToString() {
       return String.Format("DataMemberAccessor({0}, {1}, {2}, {3})",