Free cookie consent management tool by TermsFeed Policy Generator

Ignore:
Timestamp:
03/15/10 14:45:46 (14 years ago)
Author:
epitzer
Message:

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

Location:
trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString
Files:
18 edited

Legend:

Unmodified
Added
Removed

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/DebugStringFormat.cs

    r3017 r3036  
    1010namespace HeuristicLab.Persistence.Default.DebugString {
    1111
     12  /// <summary>
     13  /// Simple write-only format for debugging purposes.
     14  /// </summary>
    1215  [StorableClass]
    1316  public class DebugStringFormat : FormatBase<DebugString> {
     17    /// <summary>
     18    /// Gets the format's name.
     19    /// </summary>
     20    /// <value>The format's name.</value>
    1421    public override string Name { get { return "DebugString"; } }
    1522  }

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/DebugStringGenerator.cs

    r3005 r3036  
    99namespace HeuristicLab.Persistence.Default.DebugString {
    1010
     11  /// <summary>
     12  /// Generate a string that recursively describes an object graph.
     13  /// </summary>
    1114  public class DebugStringGenerator : GeneratorBase<string> {
    1215
    … …  
    1417    private readonly bool showRefs;
    1518
     19    /// <summary>
     20    /// Initializes a new instance of the <see cref="DebugStringGenerator"/> class.
     21    /// </summary>
    1622    public DebugStringGenerator() : this(true) { }
    1723
     24    /// <summary>
     25    /// Initializes a new instance of the <see cref="DebugStringGenerator"/> class.
     26    /// </summary>
     27    /// <param name="showRefs">if set to <c>true</c> show references.</param>
    1828    public DebugStringGenerator(bool showRefs) {
    1929      isSepReq = false;
    … …  
    2131    }
    2232
     33    /// <summary>
     34    /// Formats the specified begin token.
     35    /// </summary>
     36    /// <param name="beginToken">The begin token.</param>
     37    /// <returns>The token in serialized form.</returns>
    2338    protected override string Format(BeginToken beginToken) {
    2439      StringBuilder sb = new StringBuilder();
    … …  
    3853    }
    3954
     55    /// <summary>
     56    /// Formats the specified end token.
     57    /// </summary>
     58    /// <param name="endToken">The end token.</param>
     59    /// <returns>The token in serialized form.</returns>
    4060    protected override string Format(EndToken endToken) {
    4161      isSepReq = true;
    … …  
    4363    }
    4464
     65    /// <summary>
     66    /// Formats the specified primitive token.
     67    /// </summary>
     68    /// <param name="primitiveToken">The primitive token.</param>
     69    /// <returns>The token in serialized form.</returns>
    4570    protected override string Format(PrimitiveToken primitiveToken) {
    4671      StringBuilder sb = new StringBuilder();
    … …  
    6186    }
    6287
     88    /// <summary>
     89    /// Formats the specified reference token.
     90    /// </summary>
     91    /// <param name="referenceToken">The reference token.</param>
     92    /// <returns>The token in serialized form.</returns>
    6393    protected override string Format(ReferenceToken referenceToken) {
    6494      StringBuilder sb = new StringBuilder();
    … …  
    76106    }
    77107
     108    /// <summary>
     109    /// Formats the specified null reference token.
     110    /// </summary>
     111    /// <param name="nullReferenceToken">The null reference token.</param>
     112    /// <returns>The token in serialized form.</returns>
    78113    protected override string Format(NullReferenceToken nullReferenceToken) {
    79114      StringBuilder sb = new StringBuilder();
    … …  
    89124    }
    90125
     126    /// <summary>
     127    /// Formats the specified meta info begin token.
     128    /// </summary>
     129    /// <param name="metaInfoBeginToken">The meta info begin token.</param>
     130    /// <returns>The token in serialized form.</returns>
    91131    protected override string Format(MetaInfoBeginToken metaInfoBeginToken) {
    92132      return "[";
    93133    }
    94134
     135    /// <summary>
     136    /// Formats the specified meta info end token.
     137    /// </summary>
     138    /// <param name="metaInfoEndToken">The meta info end token.</param>
     139    /// <returns>The token in serialized form.</returns>
    95140    protected override string Format(MetaInfoEndToken metaInfoEndToken) {
    96141      return "]";
    97142    }
    98143
     144    /// <summary>
     145    /// Formats the specified type token.
     146    /// </summary>
     147    /// <param name="typeToken">The type token.</param>
     148    /// <returns>The token in serialized form.</returns>
    99149    protected override string Format(TypeToken typeToken) {
    100150      return string.Empty;
    101151    }
    102152
     153    /// <summary>
     154    /// Serializes the specified object.
     155    /// </summary>
     156    /// <param name="o">The object.</param>
     157    /// <returns>A string representation of the complete object graph</returns>
    103158    public static string Serialize(object o) {
    104159      return Serialize(o, ConfigurationService.Instance.GetDefaultConfig(new DebugStringFormat()));
    105160    }
    106161
     162    /// <summary>
     163    /// Serializes the specified object.
     164    /// </summary>
     165    /// <param name="o">The object.</param>
     166    /// <param name="configuration">The persistence configuration.</param>
     167    /// <returns>A string representation of the complete object graph.</returns>
    107168    public static string Serialize(object o, Configuration configuration) {
    108169      Serializer s = new Serializer(o, configuration);

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/PrimitiveSerializers/Bool2DebugStringSerializer.cs

    r1853 r3036  
    99namespace HeuristicLab.Persistence.Default.DebugString.PrimitiveSerializers {
    1010
    11   public class Bool2DebugStringSerializer : DebugStringSerializerBase<bool> { }
     11  internal sealed class Bool2DebugStringSerializer : DebugStringSerializerBase<bool> { }
    1212
    1313}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/PrimitiveSerializers/Byte2DebugStringSerializer.cs

    r1853 r3036  
    99namespace HeuristicLab.Persistence.Default.DebugString.PrimitiveSerializers {
    1010
    11   public class Byte2DebugStringSerializer : DebugStringSerializerBase<byte> { }
     11  internal sealed class Byte2DebugStringSerializer : DebugStringSerializerBase<byte> { }
    1212
    1313}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/PrimitiveSerializers/Char2DebugStringSerializer.cs

    r1853 r3036  
    99namespace HeuristicLab.Persistence.Default.DebugString.PrimitiveSerializers {
    1010
    11   public class Char2DebugStringSerializer : DebugStringSerializerBase<char> { }
     11  internal sealed class Char2DebugStringSerializer : DebugStringSerializerBase<char> { }
    1212
    1313}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/PrimitiveSerializers/DateTime2DebugStringSerializer.cs

    r1853 r3036  
    99namespace HeuristicLab.Persistence.Default.DebugString.PrimitiveSerializers {
    1010
    11   public class DateTime2DebugStringSerializer : DebugStringSerializerBase<DateTime> { }
     11  internal sealed class DateTime2DebugStringSerializer : DebugStringSerializerBase<DateTime> { }
    1212
    1313}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/PrimitiveSerializers/Double2DebugStringSerializer.cs

    r1853 r3036  
    99namespace HeuristicLab.Persistence.Default.DebugString.PrimitiveSerializers {
    1010
    11   public class Double2DebugStringSerializer : DebugStringSerializerBase<double> { }
     11  internal sealed class Double2DebugStringSerializer : DebugStringSerializerBase<double> { }
    1212
    1313}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/PrimitiveSerializers/Float2DebugStringSerializer.cs

    r1853 r3036  
    99namespace HeuristicLab.Persistence.Default.DebugString.PrimitiveSerializers {
    1010
    11   public class Float2DebugStringSerializer : DebugStringSerializerBase<float> { }
     11  internal sealed class Float2DebugStringSerializer : DebugStringSerializerBase<float> { }
    1212
    1313}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/PrimitiveSerializers/Int2DebugStringSerializer.cs

    r1853 r3036  
    99namespace HeuristicLab.Persistence.Default.DebugString.PrimitiveSerializers {
    1010
    11   public class Int2DebugStringSerializer : DebugStringSerializerBase<int> { }
     11  internal sealed class Int2DebugStringSerializer : DebugStringSerializerBase<int> { }
    1212
    1313}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/PrimitiveSerializers/Long2DebugStringSerializer.cs

    r1853 r3036  
    99namespace HeuristicLab.Persistence.Default.DebugString.PrimitiveSerializers {
    1010
    11   public class Long2DebugStringSerializer : DebugStringSerializerBase<long> { }
     11  internal sealed class Long2DebugStringSerializer : DebugStringSerializerBase<long> { }
    1212
    1313}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/PrimitiveSerializers/SByte2DebugStringSerializer.cs

    r1853 r3036  
    99namespace HeuristicLab.Persistence.Default.DebugString.PrimitiveSerializers {
    1010
    11   public class SByte2DebugStringSerializer : DebugStringSerializerBase<sbyte> { }
     11  internal sealed class SByte2DebugStringSerializer : DebugStringSerializerBase<sbyte> { }
    1212
    1313}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/PrimitiveSerializers/Short2DebugStringSerializer.cs

    r1853 r3036  
    99namespace HeuristicLab.Persistence.Default.DebugString.PrimitiveSerializers {
    1010
    11   public class Short2DebugStringSerializer : DebugStringSerializerBase<short> { }
     11  internal sealed class Short2DebugStringSerializer : DebugStringSerializerBase<short> { }
    1212
    1313}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/PrimitiveSerializers/String2DebugStringSerializer.cs

    r1853 r3036  
    99namespace HeuristicLab.Persistence.Default.DebugString.PrimitiveSerializers {
    1010
    11   public class String2DebugStringSerializer : DebugStringSerializerBase<string> { }
     11  internal sealed class String2DebugStringSerializer : DebugStringSerializerBase<string> { }
    1212
    1313}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/PrimitiveSerializers/Type2DebugStringSerializer.cs

    r1853 r3036  
    99namespace HeuristicLab.Persistence.Default.DebugString.PrimitiveSerializers {
    1010
    11   public class Type2DebugStringSerializer : DebugStringSerializerBase<Type> { }
     11  internal sealed class Type2DebugStringSerializer : DebugStringSerializerBase<Type> { }
    1212
    1313}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/PrimitiveSerializers/UInt2DebugStringSerializer.cs

    r1853 r3036  
    99namespace HeuristicLab.Persistence.Default.DebugString.PrimitiveSerializers {
    1010
    11   public class UInt2DebugStringSerializer : DebugStringSerializerBase<uint> { }
     11  internal sealed class UInt2DebugStringSerializer : DebugStringSerializerBase<uint> { }
    1212
    1313}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/PrimitiveSerializers/ULong2DebugStringSerializer.cs

    r1853 r3036  
    99namespace HeuristicLab.Persistence.Default.DebugString.PrimitiveSerializers {
    1010
    11   public class ULong2DebugStringSerializer : DebugStringSerializerBase<ulong> { }
     11  internal sealed class ULong2DebugStringSerializer : DebugStringSerializerBase<ulong> { }
    1212
    1313}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/PrimitiveSerializers/UShort2DebugStringSerializer.cs

    r1853 r3036  
    99namespace HeuristicLab.Persistence.Default.DebugString.PrimitiveSerializers {
    1010
    11   public class UShort2DebugStringSerializer : DebugStringSerializerBase<ushort> { }
     11  internal sealed class UShort2DebugStringSerializer : DebugStringSerializerBase<ushort> { }
    1212
    1313}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/DebugString/PrimitiveSerializers/ValueType2DebugStringSerializerBase.cs

    r1823 r3036  
    99namespace HeuristicLab.Persistence.Default.DebugString.PrimitiveSerializers {
    1010
    11   public abstract class DebugStringSerializerBase<T> : PrimitiveSerializerBase<T, DebugString> {
     11  internal abstract class DebugStringSerializerBase<T> : PrimitiveSerializerBase<T, DebugString> {
    1212    public override DebugString Format(T o) { return new DebugString(o.ToString()); }
    1313    public override T Parse(DebugString s) {
Note: See TracChangeset for help on using the changeset viewer.