Context Navigation

Tokens

Timestamp:

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

Author:

epitzer

Message:

add complete persistence API docs (#548)

Location:

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

Files:

-                      r1562
+                      r3004
 namespace HeuristicLab.Persistence.Core.Tokens {
+  /// <summary>
+  /// Marks the beginning of a composite element.
+  /// </summary>
   public class BeginToken : CompositeTokenBase {
     public BeginToken(string name, int typeId, int? id) : base(name, typeId, id) { }

-                      r1562
+                      r3004
 namespace HeuristicLab.Persistence.Core.Tokens {
+  /// <summary>
+  /// Common base class of <code>BeginToken</code> and <code>EndToken</code>
+  /// that surround a composite element.
+  /// </summary>
   public abstract class CompositeTokenBase : SerializationTokenBase {
     public readonly int TypeId;

-                      r1562
+                      r3004
 namespace HeuristicLab.Persistence.Core.Tokens {
+  /// <summary>
+  /// Marks the end of a composite element.
+  /// </summary>
   public class EndToken : CompositeTokenBase {
     public EndToken(string name, int typeId, int? id) : base(name, typeId, id) { }

r1556	r3004
2	2
3	3	namespace HeuristicLab.Persistence.Core.Tokens {
4
	4
5	5	public class MetaInfoBeginToken : ISerializationToken { }
6	6

r1566	r3004
2	2
3	3	namespace HeuristicLab.Persistence.Core.Tokens {
4
	4
5	5	public class NullReferenceToken : SerializationTokenBase {
6	6	public NullReferenceToken(string name) : base(name) { }

-                      r1566
+                      r3004
 namespace HeuristicLab.Persistence.Core.Tokens {
+  /// <summary>
+  /// Encapsulated the serialization of a single primitive value.
+  /// </summary>
   public class PrimitiveToken : SerializationTokenBase {
     public readonly int TypeId;

-                      r1566
+                      r3004
 namespace HeuristicLab.Persistence.Core.Tokens {
+  /// <summary>
+  /// References a previously used token (composite or primitive).
+  /// </summary>
   public class ReferenceToken : SerializationTokenBase {
     public readonly int Id;

r1615	r3004
4	4
5	5	namespace HeuristicLab.Persistence.Core.Tokens {
6
	6
7	7	public abstract class SerializationTokenBase : ISerializationToken {
8	8	public readonly string Name;

Note: See TracChangeset for help on using the changeset viewer.