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

Timestamp:

03/15/10 14:45:46 (15 years ago)

Author:

epitzer

Message:

make most serializers internal and complete API documentation (#548)

File:

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

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

@@ -112 +112 @@
     }
 
+    /// <summary>
+    /// Formats the specified begin token.
+    /// </summary>
+    /// <param name="beginToken">The begin token.</param>
+    /// <returns>The token in serialized form.</returns>
     protected override string Format(BeginToken beginToken) {
       var dict = new Dictionary<string, object> {
@@ -134 +139 @@
     }
 
+    /// <summary>
+    /// Formats the specified end token.
+    /// </summary>
+    /// <param name="endToken">The end token.</param>
+    /// <returns>The token in serialized form.</returns>
     protected override string Format(EndToken endToken) {
       return CreateNodeEnd(XmlStringConstants.COMPOSITE);
     }
 
+    /// <summary>
+    /// Formats the specified data token.
+    /// </summary>
+    /// <param name="dataToken">The data token.</param>
+    /// <returns>The token in serialized form.</returns>
     protected override string Format(PrimitiveToken dataToken) {
       var dict = new Dictionary<string, object> {
@@ -148 +163 @@
     }
 
+    /// <summary>
+    /// Formats the specified ref token.
+    /// </summary>
+    /// <param name="refToken">The ref token.</param>
+    /// <returns>The token in serialized form.</returns>
     protected override string Format(ReferenceToken refToken) {
       return CreateNode(XmlStringConstants.REFERENCE,
@@ -155 +175 @@
     }
 
+    /// <summary>
+    /// Formats the specified null ref token.
+    /// </summary>
+    /// <param name="nullRefToken">The null ref token.</param>
+    /// <returns>The token in serialized form.</returns>
     protected override string Format(NullReferenceToken nullRefToken) {
       return CreateNode(XmlStringConstants.NULL,
@@ -161 +186 @@
     }
 
+    /// <summary>
+    /// Formats the specified meta info begin token.
+    /// </summary>
+    /// <param name="metaInfoBeginToken">The meta info begin token.</param>
+    /// <returns>The token in serialized form.</returns>
     protected override string Format(MetaInfoBeginToken metaInfoBeginToken) {
       return CreateNodeStart(XmlStringConstants.METAINFO);
     }
 
+    /// <summary>
+    /// Formats the specified meta info end token.
+    /// </summary>
+    /// <param name="metaInfoEndToken">The meta info end token.</param>
+    /// <returns>The token in serialized form.</returns>
     protected override string Format(MetaInfoEndToken metaInfoEndToken) {
       return CreateNodeEnd(XmlStringConstants.METAINFO);
@@ -170 +205 @@
 
     private TypeToken lastTypeToken;
+    /// <summary>
+    /// Formats the specified token.
+    /// </summary>
+    /// <param name="token">The token.</param>
+    /// <returns>The token in serialized form.</returns>
     protected override string Format(TypeToken token) {
       lastTypeToken = token;
@@ -205 +245 @@
     /// <summary>
     /// Serialize an object into a file.
-    /// 
     /// The XML configuration is obtained from the <c>ConfigurationService</c>.
     /// The file is actually a ZIP file.
     /// Compression level is set to 5 and needed assemblies are not included.
-    /// </summary>    
+    /// </summary>
+    /// <param name="o">The object.</param>
+    /// <param name="filename">The filename.</param>
     public static void Serialize(object o, string filename) {
       Serialize(o, filename, ConfigurationService.Instance.GetConfiguration(new XmlFormat()), false, 5);