Changeset 3028 for trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/XmlGenerator.cs

Timestamp:

03/15/10 12:01:10 (14 years ago)

Author:

epitzer

Message:

add more API docs (#548)

File:

• trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/XmlGenerator.cs (modified) (5 diffs)

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/XmlGenerator.cs

@@ -189 +189 @@
     }
 
+    /// <summary>
+    /// Formats the specified type cache.
+    /// </summary>
+    /// <param name="typeCache">The type cache.</param>
+    /// <returns>An enumerable of formatted type cache tags.</returns>
     public IEnumerable<string> Format(List<TypeMapping> typeCache) {
       yield return CreateNodeStart(XmlStringConstants.TYPECACHE);
@@ -211 +216 @@
     /// <summary>
     /// Serialize an object into a file.
-    /// 
     /// The XML configuration is obtained from the <c>ConfigurationService</c>.
     /// Needed assemblies are not included.
     /// </summary>
+    /// <param name="o">The object.</param>
+    /// <param name="filename">The filename.</param>
     /// <param name="compression">ZIP file compression level</param>
     public static void Serialize(object o, string filename, int compression) {
@@ -220 +226 @@
     }
 
+    /// <summary>
+    /// Serializes the specified object into a file.
+    /// Needed assemblies are not included, ZIP compression level is set to 5.
+    /// </summary>
+    /// <param name="obj">The object.</param>
+    /// <param name="filename">The filename.</param>
+    /// <param name="config">The configuration.</param>
     public static void Serialize(object obj, string filename, Configuration config) {
       Serialize(obj, filename, config, false, 5);
     }
 
+    /// <summary>
+    /// Serializes the specified object into a file.
+    /// </summary>
+    /// <param name="obj">The object.</param>
+    /// <param name="filename">The filename.</param>
+    /// <param name="config">The configuration.</param>
+    /// <param name="includeAssemblies">if set to <c>true</c> include needed assemblies.</param>
+    /// <param name="compression">The ZIP compression level.</param>
     public static void Serialize(object obj, string filename, Configuration config, bool includeAssemblies, int compression) {      
       try {
@@ -278 +299 @@
     }
 
+    /// <summary>
+    /// Serializes the specified object into a stream using the <see cref="XmlFormat"/>
+    /// obtained from the <see cref="ConfigurationService"/>.
+    /// </summary>
+    /// <param name="obj">The object.</param>
+    /// <param name="stream">The stream.</param>
     public static void Serialize(object obj, Stream stream) {
       Serialize(obj, stream, ConfigurationService.Instance.GetConfiguration(new XmlFormat()));
@@ -283 +310 @@
 
 
+    /// <summary>
+    /// Serializes the specified object into a stream.
+    /// </summary>
+    /// <param name="obj">The object.</param>
+    /// <param name="stream">The stream.</param>
+    /// <param name="config">The configuration.</param>
     public static void Serialize(object obj, Stream stream, Configuration config) {
       Serialize(obj, stream, config, false);
     }
 
-    public static void Serialize(object obj, Stream stream, Configuration config, bool includeAssemblies) {
-      Serialize(obj, stream, config, includeAssemblies, true);
-    }
-
-    public static void Serialize(object obj, Stream stream, Configuration config, bool includeAssemblies, bool interleaveTypeInfo) {      
+    /// <summary>
+    /// Serializes the specified object into a stream.
+    /// </summary>
+    /// <param name="obj">The object.</param>
+    /// <param name="stream">The stream.</param>
+    /// <param name="config">The configuration.</param>
+    /// <param name="includeAssemblies">if set to <c>true</c> include need assemblies.</param>
+    public static void Serialize(object obj, Stream stream, Configuration config, bool includeAssemblies) {      
       try {
         using (StreamWriter writer = new StreamWriter(new GZipStream(stream, CompressionMode.Compress))) {