Changeset 3016 for trunk/sources/HeuristicLab.Persistence/3.3/Auxiliary

Timestamp:

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

Author:

epitzer

Message:

Update API docs. (#548)

Location:

trunk/sources/HeuristicLab.Persistence/3.3/Auxiliary

Files:

• TypeExtensions.cs (modified) (1 diff)
• TypeName.cs (modified) (7 diffs)
• TypeNameParser.cs (modified) (3 diffs)

trunk/sources/HeuristicLab.Persistence/3.3/Auxiliary/TypeExtensions.cs

@@ -4 +4 @@
 namespace HeuristicLab.Persistence.Auxiliary {
 
+  /// <summary>
+  /// Extension methods for the <see cref="Type"/> class.
+  /// </summary>
   public static class TypeExtensions {
 
+    /// <summary>
+    /// Get an assembly qualified name withough version information.
+    /// </summary>
+    /// <param name="type">The type.</param>
+    /// <returns>A full type name without version information.</returns>
     public static string VersionInvariantName(this Type type) {
       return TypeNameParser.Parse(type.AssemblyQualifiedName).ToString(false);

trunk/sources/HeuristicLab.Persistence/3.3/Auxiliary/TypeName.cs

@@ -7 +7 @@
 
 namespace HeuristicLab.Persistence.Auxiliary {
-  
+
   /// <summary>
   /// Contains a more modular representation of type names that can
@@ -16 +16 @@
   public class TypeName {
 
+    /// <summary>
+    /// Gets or sets the namespace.
+    /// </summary>
+    /// <value>The namespace.</value>
     [Storable]
     public string Namespace { get; private set; }
 
+    /// <summary>
+    /// Gets or sets the name of the class.
+    /// </summary>
+    /// <value>The name of the class.</value>
     [Storable]
     public string ClassName { get; private set; }
 
+    /// <summary>
+    /// Gets or sets the generic args.
+    /// </summary>
+    /// <value>The generic args.</value>
     [Storable]
     public List<TypeName> GenericArgs { get; internal set; }
     public bool IsGeneric { get { return GenericArgs.Count > 0; } }
 
+    /// <summary>
+    /// Gets or sets the memory magic (point or array declaration).
+    /// </summary>
+    /// <value>The memory magic.</value>
     [Storable]
     public string MemoryMagic { get; internal set; }
 
+    /// <summary>
+    /// Gets or sets the name of the assembly.
+    /// </summary>
+    /// <value>The name of the assembly.</value>
     [Storable]
     public string AssemblyName { get; internal set; }
 
+    /// <summary>
+    /// Gets or sets the assembly attribues.
+    /// </summary>
+    /// <value>The assembly attribues.</value>
     [Storable]
     public Dictionary<string, string> AssemblyAttribues { get; internal set; }
 
+    /// <summary>
+    /// Gets or sets a value indicating whether this instance is reference.
+    /// </summary>
+    /// <value>
+    ///   <c>true</c> if this instance is reference; otherwise, <c>false</c>.
+    /// </value>
     [Storable]
     public bool IsReference { get; internal set; }
 
+
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="TypeName"/> class.
+    /// </summary>
+    /// <param name="nameSpace">The namespace.</param>
+    /// <param name="className">Name of the class.</param>
     internal TypeName(string nameSpace, string className) {
       Namespace = nameSpace;
@@ -46 +83 @@
     }
 
-    /// <param name="full">include assembly properties and generic parameters</param>    
+
+    /// <summary>
+    /// Returns a <see cref="System.String"/> that represents this instance.
+    /// </summary>
+    /// <param name="full">if set to <c>true</c> includes full informatoin
+    /// about generic parameters and assembly properties.</param>
+    /// <returns>
+    /// A <see cref="System.String"/> that represents this instance.
+    /// </returns>
     public string ToString(bool full) {
       return ToString(full, true);
@@ -52 +97 @@
 
 
-    /// <param name="full">include assembly properties and generic parameters</param>    
+    /// <summary>
+    /// Returns a <see cref="System.String"/> that represents this instance.
+    /// </summary>
+    /// <param name="includeAssembly">if set to <c>true</c> include assembly properties and generic parameters.</param>
+    /// <returns>
+    /// A <see cref="System.String"/> that represents this instance.
+    /// </returns>
     public string ToString(bool full, bool includeAssembly) {      
       StringBuilder sb = new StringBuilder();
@@ -80 +131 @@
     }
 
+
+    /// <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() {
       return ToString(true);
@@ -88 +146 @@
     /// Lexicographically compare version information and make sure type and assembly
     /// names are identical. This function recursively checks generic type arguments.
-    /// </summary>    
+    /// </summary>
+    /// <param name="typeName">Name of the type.</param>
+    /// <returns>
+    ///   <c>true</c> if is newer than the specified type name; otherwise, <c>false</c>.
+    /// </returns>
     public bool IsNewerThan(TypeName typeName) {
       try {
@@ -117 +179 @@
     /// recursively checks generic type arguments.
     /// </summary>
+    /// <param name="typeName">Name of the type.</param>
+    /// <returns>
+    ///   <c>true</c> if the specified type names are compatible; otherwise, <c>false</c>.
+    /// </returns>
     public bool IsCompatible(TypeName typeName) {
       try {

trunk/sources/HeuristicLab.Persistence/3.3/Auxiliary/TypeNameParser.cs

@@ -7 +7 @@
 namespace HeuristicLab.Persistence.Auxiliary {
 
+  /// <summary>
+  /// Error during type name parsing, thrown by <see cref="TypeNameParser"/>.
+  /// </summary>
   public class ParseError : Exception {
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ParseError"/> class.
+    /// </summary>
+    /// <param name="message">The message.</param>
     public ParseError(string message) : base(message) { }
   }
-
 
   /// <summary>
   /// Parse a .NET type name using the following grammar:  
   ///   
-  /// <para><code>
+  /// <code>
   /// TypeSpec := SimpleTypeSpec '&amp;'?  
-  /// </code></para>
   /// 
-  /// <para><code>
   /// SimpleTypeSpec := (IDENTIFIER '.')*
   ///                   (IDENTIFIER '+')*
@@ -26 +31 @@
   ///                   (\*|\[(\d+\.\.\d+|\d+\.\.\.|(|\*)(,(|\*))*)\])* 
   ///                   (',\s*' IDENTIFIER (',\s*' AssemblyProperty)* )?  
-  /// </code></para>
   ///
-  /// <para><code>
   /// Generics := '[' SimpleTypeSpec ']' (',[' SimpleTypeSpec ']')
-  /// </code></para>
   ///
-  /// <para><code>
   /// AssemblyProperty := 'Version=' Version
   ///                  |  'PublicKey(Token)?=[a-fA-F0-9]+'
   ///                  |  'Culture=[a-zA-F0-9]+'
-  /// </code></para>
   ///
-  /// <para><code>
   /// Version := \d+\.\d+\.\d+\.\d+
-  /// </code></para>
   ///
-  /// <para><code>
   /// IDENTIFIER = [_a-zA-Z][_a-ZA-Z0-9]*  
-  /// </code></para>
+  /// </code>
   /// </summary>
   public class TypeNameParser {
@@ -135 +132 @@
     }
 
+    /// <summary>
+    /// Parses the specified typename string as obtained by
+    /// <c>System.Object.GetType().FullName"</c>.
+    /// </summary>
+    /// <param name="s">The typename string.</param>
+    /// <returns>A <see cref="TypeName"/> representing the type name.</returns>
     public static TypeName Parse(string s) {
       TypeNameParser p = new TypeNameParser(s);