xml docs + nuget stuff

Author: sandrock

.gitignore

@@ -229,3 +229,6 @@ $RECYCLE.BIN/
 
 # Windows shortcuts
 *.lnk
+
+lib
+tools/NuGet.exe

res/logo-16.png

@@ -7,24 +7,54 @@ namespace SrkCsv
     using System.Text;
     using System.Threading.Tasks;
 
+    /// <summary>
+    /// Cell information and data.
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
     public class Cell<T>
     {
         private bool isDisposed;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Cell{T}"/> class.
+        /// </summary>
         public Cell()
         {
         }
 
+        /// <summary>
+        /// Gets or sets the row.
+        /// </summary>
         public Row<T> Row { get; set; }
+
+        /// <summary>
+        /// Gets or sets the column.
+        /// </summary>
         public Column<T> Column { get; set; }
+
+        /// <summary>
+        /// Gets or sets the value.
+        /// </summary>
         public string Value { get; set; }
 
+        /// <summary>
+        /// Gets or sets the target object.
+        /// </summary>
+        public T Target { get; set; }
+
+        /// <summary>
+        /// Releases unmanaged and - optionally - managed resources.
+        /// </summary>
         public void Dispose()
         {
             this.Dispose(true);
             GC.SuppressFinalize(this);
         }
 
+        /// <summary>
+        /// Releases unmanaged and - optionally - managed resources.
+        /// </summary>
+        /// <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
         protected virtual void Dispose(bool disposing)
         {
             if (!this.isDisposed)
@@ -43,7 +73,5 @@ internal object GetTarget()
         {
             return null;
         }
-
-        public T Target { get; set; }
     }
 }

res/logo-200.png

@@ -7,49 +7,33 @@ namespace SrkCsv
     using System.Text;
     using System.Threading.Tasks;
 
+    /// <summary>
+    /// Column information.
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
     public class Column<T>
     {
-        private Action<Cell<T>> parser;
-
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Column{T}"/> class.
+        /// </summary>
+        /// <param name="index">The index.</param>
+        /// <param name="col">The col.</param>
         public Column(int index, string col)
         {
             this.Index = index;
             this.Name = col;
-
-            ////this.CreateParser();
         }
 
+        /// <summary>
+        /// Gets or sets the column index.
+        /// </summary>
         public int Index { get; set; }
 
+        /// <summary>
+        /// Gets or sets the name.
+        /// </summary>
         public string Name { get; set; }
 
         internal Predicate<Cell<T>> Transform { get; set; }
-
-        ////public static IList<ColumnParser> Parsers
-        ////{
-        ////    get { return parsers.Select(p => new ColumnParser { Name = p.Key, }).ToArray(); }
-        ////}
-
-        ////public void Parse(Cell<T> cell)
-        ////{
-        ////    if (this.parser != null)
-        ////    {
-        ////        this.parser(cell);
-        ////    }
-        ////}
-
-        ////private static void AddParser(ColumnParser parser)
-        ////{
-        ////    parsers.Add(parser.Name.ToLowerInvariant(), parser);
-        ////}
-
-        ////private void CreateParser()
-        ////{
-        ////    var lowerName = this.Name.ToLowerInvariant();
-        ////    if (parsers.ContainsKey(lowerName))
-        ////        this.parser = parsers[lowerName].Action;
-        ////    else
-        ////        throw new InvalidOperationException("Unrecognized column '" + this.Name + "' ");
-        ////}
     }
 }

res/logo-2000.png

@@ -6,38 +6,68 @@ namespace SrkCsv
     using System.Linq;
     using System.Runtime.Serialization;
     using System.Text;
-    using System.Threading.Tasks;
 
+    /// <summary>
+    /// Exception that occur during parsing operations.
+    /// </summary>
     [Serializable]
     public class CsvParseException : Exception
     {
         private readonly string[] errors;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CsvParseException"/> class.
+        /// </summary>
         public CsvParseException()
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CsvParseException"/> class.
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
         public CsvParseException(string message)
             : base(message)
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CsvParseException"/> class.
+        /// </summary>
+        /// <param name="message">The message.</param>
+        /// <param name="inner">The inner.</param>
         public CsvParseException(string message, Exception inner)
             : base(message, inner)
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CsvParseException"/> class.
+        /// </summary>
+        /// <param name="message">The message.</param>
+        /// <param name="errors">The errors.</param>
         public CsvParseException(string message, IEnumerable<string> errors)
             : this(message)
         {
             this.errors = errors.ToArray();
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CsvParseException"/> class.
+        /// </summary>
+        /// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
+        /// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
         protected CsvParseException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {
         }
 
+        /// <summary>
+        /// Gets the errors.
+        /// </summary>
+        /// <value>
+        /// The errors.
+        /// </value>
         public IList<string> Errors
         {
             get { return this.errors; }

res/logo-32.png

@@ -11,6 +11,9 @@ namespace SrkCsv
     using System.Text;
     using System.Threading.Tasks;
 
+    /// <summary>
+    /// Basic CSV reader.
+    /// </summary>
     public class CsvReader : CsvReader<Nothing>
     {
         public CsvReader()
@@ -24,30 +27,56 @@ public CsvReader(Table table)
         }
     }
 
+    /// <summary>
+    /// CSV reader with support for a target object type.
+    /// </summary>
+    /// <typeparam name="T">the target object type</typeparam>
     public class CsvReader<T>
     {
         private readonly Table<T> table;
         private CultureInfo culture = CultureInfo.InvariantCulture;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CsvReader{T}"/> class.
+        /// </summary>
         public CsvReader()
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CsvReader{T}"/> class.
+        /// </summary>
+        /// <param name="table">The table.</param>
         public CsvReader(Table<T> table)
         {
             this.table = table;
         }
 
+        /// <summary>
+        /// Gets or sets the cell separator.
+        /// </summary>
+        /// <value>
         public char CellSeparator { get; set; }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether [has header line].
+        /// </summary>
         public bool HasHeaderLine { get; set; }
 
+        /// <summary>
+        /// Gets or sets the culture.
+        /// </summary>
         public CultureInfo Culture
         {
             get { return this.culture; }
             set { this.culture = value; }
         }
 
+        /// <summary>
+        /// Reads to end.
+        /// </summary>
+        /// <param name="reader">The reader.</param>
+        /// <returns></returns>
         public Table<T> ReadToEnd(StringReader reader)
         {
             var data = new List<List<string>>();

res/logo-64.png

@@ -3,8 +3,14 @@ namespace SrkCsv
 {
     using System;
 
+    /// <summary>
+    /// Special separators.
+    /// </summary>
     public static class CsvSeparator
     {
+        /// <summary>
+        /// Special separator: instructs to detect separator from the first lines in the file.
+        /// </summary>
         public const char AutoDetect = '\0';
     }
 }

res/logo.svg

@@ -3,6 +3,9 @@ namespace SrkCsv.Internals
 {
     using System;
 
+    /// <summary>
+    /// Used for non-generic CsvReader.
+    /// </summary>
     public class Nothing
     {
     }