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

Timestamp:

03/11/10 12:54:14 (14 years ago)

Author:

epitzer

Message:

add complete persistence API docs (#548)

File:

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

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

@@ -5 +5 @@
 namespace HeuristicLab.Persistence.Default.CompositeSerializers.Storable {
 
+  /// <summary>
+  /// Encapsulation and abstraction for access a data member of an object
+  /// regardless of it being a property or field. Addicionally a
+  /// default value and an alternate name can be specified.
+  /// </summary>
   public class DataMemberAccessor {
 
@@ -12 +17 @@
     public readonly object DefaultValue;
 
+
+    /// <summary>
+    /// Create a DataMemberAccessor from a FieldInfo or PropertyInfo for the give object.
+    /// </summary>
     public DataMemberAccessor(MemberInfo memberInfo, string name, object defaultvalue, object obj) {
       Name = name;
@@ -33 +42 @@
     }
 
+    /// <summary>
+    /// Wrap existing getter and setter functions.
+    /// </summary>
     public DataMemberAccessor(string name, object defaultValue,
         Func<object> getter, Action<object> setter) {
@@ -40 +52 @@
       Set = setter;
     }
-
+    
+    /// <summary>
+    /// Create an empty accessor that just encapsulates an object
+    /// without access.
+    /// </summary>
     public DataMemberAccessor(object o) {
       Name = null;
@@ -48 +64 @@
     }
 
+    /// <summary>
+    /// Create an empty accessor that just encapsulates an object
+    /// without access.
+    /// </summary>
     public DataMemberAccessor(object o, string name) {
       Name = name;
@@ -54 +74 @@
       Set = null;
     }
-
 
     public override string ToString() {