Backported XML comments + minor tweaks from ExcelDataReader

Author: andersnm

src/ExcelNumberFormat/ExcelNumberFormat.csproj

@@ -2,6 +2,7 @@
 
   <PropertyGroup>
     <TargetFrameworks>net20;netstandard1.0</TargetFrameworks>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
 </Project>

src/ExcelNumberFormat/NumberFormat.cs

@@ -4,8 +4,15 @@
 
 namespace ExcelNumberFormat
 {
+    /// <summary>
+    /// Parse ECMA-376 number format strings and format values like Excel and other spreadsheet softwares.
+    /// </summary>
     public class NumberFormat
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="NumberFormat"/> class.
+        /// </summary>
+        /// <param name="formatString">The number format string.</param>
         public NumberFormat(string formatString)
         {
             var sections = Parser.ParseSections(formatString, out bool syntaxError);
@@ -16,35 +23,43 @@ public NumberFormat(string formatString)
             if (IsValid)
             {
                 Sections = sections;
+                IsDateTimeFormat = Evaluator.GetFirstSection(Sections, SectionType.Date) != null;
+                IsTimeSpanFormat = Evaluator.GetFirstSection(Sections, SectionType.Duration) != null;
             }
             else
             {
                 Sections = new List<Section>();
             }
         }
 
+        /// <summary>
+        /// Gets a value indicating whether the number format string is valid.
+        /// </summary>
         public bool IsValid { get; }
 
+        /// <summary>
+        /// Gets the number format string.
+        /// </summary>
         public string FormatString { get; }
 
-        internal List<Section> Sections { get; }
+        /// <summary>
+        /// Gets a value indicating whether the format represents a DateTime
+        /// </summary>
+        public bool IsDateTimeFormat { get; }
 
-        public bool IsDateTimeFormat
-        {
-            get
-            {
-                return Evaluator.GetFirstSection(Sections, SectionType.Date) != null;
-            }
-        }
+        /// <summary>
+        /// Gets a value indicating whether the format represents a TimeSpan
+        /// </summary>
+        public bool IsTimeSpanFormat { get; }
 
-        public bool IsTimeSpanFormat
-        {
-            get
-            {
-                return Evaluator.GetFirstSection(Sections, SectionType.Duration) != null;
-            }
-        }
+        internal List<Section> Sections { get; }
 
+        /// <summary>
+        /// Formats a value with this number format in a specified culture.
+        /// </summary>
+        /// <param name="value">The value to format.</param>
+        /// <param name="culture">The culture to use for formatting.</param>
+        /// <returns>The formatted string.</returns>
         public string Format(object value, CultureInfo culture)
         {
             if (!IsValid || string.IsNullOrEmpty(FormatString))