Changeset 3016 for trunk/sources/HeuristicLab.Persistence/3.3/Core/Tokens

Timestamp:

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

Author:

epitzer

Message:

Update API docs. (#548)

Location:

trunk/sources/HeuristicLab.Persistence/3.3/Core/Tokens

Files:

• BeginToken.cs (modified) (1 diff)
• CompositeTokenBase.cs (modified) (1 diff)
• EndToken.cs (modified) (1 diff)
• MetaInfoBeginToken.cs (modified) (1 diff)
• MetaInfoEndToken.cs (modified) (1 diff)
• NulLReferenceToken.cs (modified) (1 diff)
• PrimitiveToken.cs (modified) (1 diff)
• ReferenceToken.cs (modified) (1 diff)
• SerializationTokenBase.cs (modified) (1 diff)
• TypeToken.cs (modified) (1 diff)

trunk/sources/HeuristicLab.Persistence/3.3/Core/Tokens/BeginToken.cs

@@ -8 +8 @@
   /// </summary>
   public class BeginToken : CompositeTokenBase {
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="BeginToken"/> class.
+    /// </summary>
+    /// <param name="name">The token name.</param>
+    /// <param name="typeId">The type id.</param>
+    /// <param name="id">The object id.</param>
     public BeginToken(string name, int typeId, int? id) : base(name, typeId, id) { }
   }

trunk/sources/HeuristicLab.Persistence/3.3/Core/Tokens/CompositeTokenBase.cs

@@ -3 +3 @@
 
   /// <summary>
-  /// Common base class of <code>BeginToken</code> and <code>EndToken</code>
+  /// Common base class of <c>BeginToken</c> and <c>EndToken</c>
   /// that surround a composite element.
   /// </summary>
   public abstract class CompositeTokenBase : SerializationTokenBase {
+
+    /// <summary>
+    /// The type's id.
+    /// </summary>
     public readonly int TypeId;
+
+
+    /// <summary>
+    /// The object's id for references in case it is a reference type.
+    /// </summary>
     public readonly int? Id;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="CompositeTokenBase"/> class.
+    /// </summary>
+    /// <param name="name">The name.</param>
+    /// <param name="typeId">The type id.</param>
+    /// <param name="id">The object id.</param>
     public CompositeTokenBase(string name, int typeId, int? id)
       : base(name) {

trunk/sources/HeuristicLab.Persistence/3.3/Core/Tokens/EndToken.cs

@@ -7 +7 @@
   /// </summary>
   public class EndToken : CompositeTokenBase {
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="EndToken"/> class.
+    /// </summary>
+    /// <param name="name">The name.</param>
+    /// <param name="typeId">The type id.</param>
+    /// <param name="id">The object id.</param>
     public EndToken(string name, int typeId, int? id) : base(name, typeId, id) { }
   }

trunk/sources/HeuristicLab.Persistence/3.3/Core/Tokens/MetaInfoBeginToken.cs

@@ -2 +2 @@
 
 namespace HeuristicLab.Persistence.Core.Tokens {
-  
+
+  /// <summary>
+  /// Start of meta information.
+  /// </summary>
   public class MetaInfoBeginToken : ISerializationToken { }
 

trunk/sources/HeuristicLab.Persistence/3.3/Core/Tokens/MetaInfoEndToken.cs

@@ -3 +3 @@
 namespace HeuristicLab.Persistence.Core.Tokens {
 
+  /// <summary>
+  /// End of meta info.
+  /// </summary>
   public class MetaInfoEndToken : ISerializationToken { }
 

trunk/sources/HeuristicLab.Persistence/3.3/Core/Tokens/NulLReferenceToken.cs

@@ -2 +2 @@
 
 namespace HeuristicLab.Persistence.Core.Tokens {
-  
+
+  /// <summary>
+  /// Describes a reference to <c>null</c>.
+  /// </summary>
   public class NullReferenceToken : SerializationTokenBase {
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="NullReferenceToken"/> class.
+    /// </summary>
+    /// <param name="name">The token name.</param>
     public NullReferenceToken(string name) : base(name) { }
   }

trunk/sources/HeuristicLab.Persistence/3.3/Core/Tokens/PrimitiveToken.cs

@@ -7 +7 @@
   /// </summary>
   public class PrimitiveToken : SerializationTokenBase {
+
+    /// <summary>
+    /// The type's id.
+    /// </summary>
     public readonly int TypeId;
+
+    /// <summary>
+    /// The object's id.
+    /// </summary>
     public readonly int? Id;
+
+    /// <summary>
+    /// The serialized data.
+    /// </summary>
     public readonly ISerialData SerialData;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PrimitiveToken"/> class.
+    /// </summary>
+    /// <param name="name">The name.</param>
+    /// <param name="typeId">The type's id.</param>
+    /// <param name="id">The onbject's id.</param>
+    /// <param name="serialData">The serialized data.</param>
     public PrimitiveToken(string name, int typeId, int? id, ISerialData serialData)
       : base(name) {

trunk/sources/HeuristicLab.Persistence/3.3/Core/Tokens/ReferenceToken.cs

@@ -8 +8 @@
   /// </summary>
   public class ReferenceToken : SerializationTokenBase {
+    /// <summary>
+    /// The refereced object's id.
+    /// </summary>
     public readonly int Id;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ReferenceToken"/> class.
+    /// </summary>
+    /// <param name="name">The name.</param>
+    /// <param name="id">The referenced object's id.</param>
     public ReferenceToken(string name, int id)
       : base(name) {

trunk/sources/HeuristicLab.Persistence/3.3/Core/Tokens/SerializationTokenBase.cs

@@ -4 +4 @@
 
 namespace HeuristicLab.Persistence.Core.Tokens {
-  
+
+  /// <summary>
+  /// Common base class for all serialization tokens.
+  /// </summary>
   public abstract class SerializationTokenBase : ISerializationToken {
+
+    /// <summary>
+    /// The token's name.
+    /// </summary>
     public readonly string Name;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SerializationTokenBase"/> class.
+    /// </summary>
+    /// <param name="name">The token name.</param>
     public SerializationTokenBase(string name) {
       Name = name;
     }
+
+    /// <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() {
       StringBuilder sb = new StringBuilder();

trunk/sources/HeuristicLab.Persistence/3.3/Core/Tokens/TypeToken.cs

@@ -7 +7 @@
 namespace HeuristicLab.Persistence.Core.Tokens {
 
+  /// <summary>
+  /// A token containing type information and mapping.
+  /// </summary>
   public class TypeToken : ISerializationToken {
+
+    /// <summary>
+    /// The type id.
+    /// </summary>
     public readonly int Id;
+
+    /// <summary>
+    /// The type's full name.
+    /// </summary>
     public readonly string TypeName;
+
+    /// <summary>
+    /// The full type name of the serialized used to
+    /// serialize the type.
+    /// </summary>
     public readonly string Serializer;
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="TypeToken"/> class.
+    /// </summary>
+    /// <param name="id">The type id.</param>
+    /// <param name="typeName">Full name of the type.</param>
+    /// <param name="serializer">The full name of the serializer
+    /// used to serialize the type.</param>
     public TypeToken(int id, string typeName, string serializer) {
       Id = id;