Added XML documentation

Author: LucaMozzo

CSVSerializer.NET/CSVFileExcepion.cs

@@ -1,13 +1,16 @@
 using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace CSVSerializer
 {
+    /// <summary>
+    /// Exception thrown whenever the file is not regognized to be a valid csv file
+    /// </summary>
     public class CSVFileExcepion : Exception
     {
+        /// <summary>
+        /// Constructor for the message containing details of the exception
+        /// </summary>
+        /// <param name="message">Details of the exception</param>
         public CSVFileExcepion(string message) : base(message)
         {
             message = "The input file is not a valid CSV file!\n" + message;

CSVSerializer.NET/Deserializer.cs

@@ -4,21 +4,31 @@
 namespace CSVSerializer
 {
     /// <summary>
-    ///  This class allows you to deserialize a CSV file or an array 
+    ///  This class allows you to deserialize a CSV file or an array of bytes
     /// </summary>
     public class Deserializer
     {
         private StreamReader File;
-
+        /// <summary>
+        /// Constructor that requires the path of the file. It may throw a FileNotFoundException, deal with it
+        /// </summary>
+        /// <param name="FilePath">The path of the csv file</param>
         public Deserializer(String FilePath)
         {
                 File = new StreamReader(FilePath); //may throw an exception if the file is not found, to be handled by the final user
         }
+        /// <summary>
+        /// Constructor that requires the content of the file
+        /// </summary>
+        /// <param name="buffer">An array of bytes that represent the csv file</param>
         public Deserializer(byte[] buffer)
         {
             this.File = new StreamReader(new MemoryStream(buffer));
         }
-
+        /// <summary>
+        /// Deserialize the file defined in the constructor
+        /// </summary>
+        /// <returns>A Document containing the deserialized values</returns>
         public Document Deserialize()
         {
             Document doc = new Document();

CSVSerializer.NET/Document.cs

@@ -1,33 +1,56 @@
 using System;
 using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace CSVSerializer
 {
+    /// <summary>
+    /// Structured document for a better organization of the data
+    /// </summary>
     public class Document
     {
+        /// <summary>
+        /// Headers of the document (usually the first row)
+        /// </summary>
         public List<String> Headers { get; }
+        /// <summary>
+        /// List of rows, which are the body of the document
+        /// </summary>
         public List<Row> Rows { get; }
+        /// <summary>
+        /// Constructor that requires headers and rows
+        /// </summary>
+        /// <param name="Headers">Name of the columns in the document</param>
+        /// <param name="Rows">Body of the document</param>
         public Document(List<String> Headers, List<Row> Rows)
         {
             this.Rows = Rows;
             this.Headers = Headers;
         }
+        /// <summary>
+        /// Empty constructor
+        /// </summary>
         public Document()
         {
             Headers = new List<String>();
             Rows = new List<Row>();
         }
+        /// <summary>
+        /// Allows to set the header for the document
+        /// </summary>
+        /// <param name="header">Header of the document</param>
         public void SetHeader(Row header)
         {
             foreach (Value v in header.Values)
                 Headers.Add(v.ToString());
         }
+        /// <summary>
+        /// Allows to add a row to the document
+        /// </summary>
+        /// <param name="row">The row to be added</param>
         public void AddRow(Row row)
         {
             Rows.Add(row);
         }
+        //TODO: Add indexed and allow more manipulation of the document, including removing rows and setting header from a List<String>
     }
 }

CSVSerializer.NET/Row.cs

@@ -1,32 +1,49 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
+using System.Collections.Generic;
 
 namespace CSVSerializer
 {
+    /// <summary>
+    /// A row is a set of values
+    /// </summary>
     public class Row
     {
+        /// <summary>
+        /// The content of the row
+        /// </summary>
         public List<Value> Values { get; }
+        /// <summary>
+        /// Constructor that requires a list of values
+        /// </summary>
+        /// <param name="Values">Values to be added</param>
         public Row(List<Value> Values)
         {
             this.Values = Values;
         }
+        /// <summary>
+        /// Empty constructor
+        /// </summary>
         public Row()
         {
             Values = new List<Value>();
         }
-        public void AddValue(Value v)
+        /// <summary>
+        /// Adds a value to the row
+        /// </summary>
+        /// <param name="value">Value to be added</param>
+        public void AddValue(Value value)
         {
-            Values.Add(v);
+            Values.Add(value);
         }
+        /// <summary>
+        /// Update the value at the specified index
+        /// </summary>
+        /// <param name="Index">Index of the value to be updated</param>
+        /// <param name="NewValue">Updated values</param>
         public void UpdateValue(int Index, Value NewValue)
         {
-            //delegates the Value class to update the value
             try
             {
-                Values[Index].UpdateValue(NewValue);
+                Values[Index].UpdateValue(NewValue); //delegates the Value class to update the value
             }
             catch { }
         }

CSVSerializer.NET/Serializer.cs

@@ -1,34 +1,45 @@
 using System;
 using System.Collections.Generic;
-using System.Linq;
-using System.Text;
 using System.Threading.Tasks;
 using System.IO;
 
 namespace CSVSerializer
 {
+    /// <summary>
+    /// This class allows you to Serialize a document or a list of rows
+    /// </summary>
     public class Serializer
     {
         private List<Row> Rows;
         private Document Document;
         private String FilePath;
+        /// <summary>
+        /// Constructor that requires a list of rows and the path of the file
+        /// </summary>
+        /// <param name="Rows">The body of the document</param>
+        /// <param name="FilePath">Path of the file to be serialized</param>
         public Serializer(List<Row> Rows, String FilePath)
         {
             this.Rows = Rows;
             this.FilePath = FilePath;
         }
-
+        /// <summary>
+        /// Constructor that requires a Document and the path of the file to be serialized
+        /// </summary>
+        /// <param name="Document">The document to be serialize</param>
+        /// <param name="FilePath">Path of the file to be serialized</param>
         public Serializer(Document Document, String FilePath)
         {
             this.Document = Document;
             this.FilePath = FilePath;
         }
-        
-        /*
-         * if it's a document we first add the headers, otherwise we assume that the headers are in the first row
-         */
+         /// <summary>
+         /// Serializes the specified document to the specified file path
+         /// </summary>
+         /// <returns>True if the task completes with no errors</returns>
         public async Task<bool> Serialize()
         {
+            //if it's a document we first add the headers, otherwise we assume that the headers are in the first row
             try
             {
                 if (!File.Exists(FilePath))

CSVSerializer.NET/Value.cs

@@ -1,40 +1,71 @@
 using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace CSVSerializer
 {
+    /// <summary>
+    /// Represents a value of an implicit type
+    /// </summary>
     public class Value
     {
         internal Type Type { get; }
         private object value;
-
+        /// <summary>
+        /// Constructor for integer values
+        /// </summary>
+        /// <param name="v">Integer value</param>
         public Value(int v)
         {
             value = v;
             Type = typeof(int);
         }
+        /// <summary>
+        /// Constructor for double value
+        /// </summary>
+        /// <param name="v">Double value</param>
         public Value(double v)
         {
             value = v;
             Type = typeof(double);
         }
+        /// <summary>
+        /// Constructor for string values
+        /// </summary>
+        /// <param name="v">String value</param>
         public Value(String v)
         {
             value = v;
             Type = typeof(String);
         }
+        /// <summary>
+        /// Constructor for specified types
+        /// </summary>
+        /// <param name="v">Value casted to any type</param>
+        /// <param name="t">Explicit type of the value</param>
+        public Value(object v, Type t)
+        {
+            Type = t;
+            value = v;
+        }
+        /// <summary>
+        /// Getter method for the value
+        /// </summary>
+        /// <returns>The actual value</returns>
         public Type GetValue()
         {
             return (Type) value;
         }
+        /// <summary>
+        /// Method for updating the actual value of this Value
+        /// </summary>
+        /// <param name="NewValue">New value that will replace the old one</param>
         public void UpdateValue(Value NewValue)
         {
             value = NewValue;
         }
-
+        /// <summary>
+        /// Override method for ToString
+        /// </summary>
+        /// <returns>The string representation of the object</returns>
         public override string ToString()
         {
             if (Type == typeof(String))