Changeset 3016 for trunk/sources/HeuristicLab.Persistence/3.3/Interfaces/IPrimitiveSerializer.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/Interfaces/IPrimitiveSerializer.cs (modified) (2 diffs)

trunk/sources/HeuristicLab.Persistence/3.3/Interfaces/IPrimitiveSerializer.cs

@@ -9 +9 @@
   /// </summary>
   public interface IPrimitiveSerializer {
+
+    /// <summary>
+    /// Gets the type of the serial data.
+    /// </summary>
+    /// <value>The type of the serial data.</value>
     Type SerialDataType { get; }
+
+    /// <summary>
+    /// Gets the source type.
+    /// </summary>
+    /// <value>The type of the source.</value>
     Type SourceType { get; }
+
+    /// <summary>
+    /// Creates a serialized representation of the provided object.
+    /// </summary>
+    /// <param name="o">The object.</param>
+    /// <returns>A serialized version of the object.</returns>
     ISerialData Format(object o);
-    object Parse(ISerialData o);
+
+
+    /// <summary>
+    /// Creates a fresh object instance using the serializes data..
+    /// </summary>
+    /// <param name="data">The data.</param>
+    /// <returns>A fresh object instance.</returns>
+    object Parse(ISerialData data);
   }
 
@@ -20 +43 @@
   /// of implementing this interface.
   /// </summary>
+  /// <typeparam name="Source">The source type.</typeparam>
+  /// <typeparam name="SerialData">The serialized data type.</typeparam>
   public interface IPrimitiveSerializer<Source, SerialData> : IPrimitiveSerializer where SerialData : ISerialData {
+
+    /// <summary>
+    /// Creates a serialized version of the provided object.
+    /// </summary>
+    /// <param name="o">The object.</param>
+    /// <returns>A serialized version of the object.</returns>
     SerialData Format(Source o);
-    Source Parse(SerialData t);
+
+
+    /// <summary>
+    /// Creates a fresh object instance from the serialized data
+    /// </summary>
+    /// <param name="data">The data.</param>
+    /// <returns>A fresh object instance.</returns>
+    Source Parse(SerialData data);
   }