From d66c92403e20143f885a629bec55594c8593fd83 Mon Sep 17 00:00:00 2001
From: Matt Nadareski <mnadareski@outlook.com>
Date: Mon, 21 Dec 2020 11:38:56 -0800
Subject: [PATCH] Add proper block comments to DatTools classes

---
 SabreTools.DatTools/DatFileTool.cs  | 4 +++-
 SabreTools.DatTools/Modification.cs | 4 +++-
 SabreTools.DatTools/Parser.cs       | 4 +++-
 SabreTools.DatTools/Rebuilder.cs    | 4 +++-
 SabreTools.DatTools/Splitter.cs     | 6 ++++--
 SabreTools.DatTools/Statistics.cs   | 4 ++++
 SabreTools.DatTools/Verification.cs | 4 +++-
 SabreTools.DatTools/Writer.cs       | 4 +++-
 8 files changed, 26 insertions(+), 8 deletions(-)

diff --git a/SabreTools.DatTools/DatFileTool.cs b/SabreTools.DatTools/DatFileTool.cs
index c773bc0e..4b40dccb 100644
--- a/SabreTools.DatTools/DatFileTool.cs
+++ b/SabreTools.DatTools/DatFileTool.cs
@@ -11,7 +11,9 @@ using SabreTools.Logging;
 
 namespace SabreTools.DatTools
 {
-    // This file represents all methods related to converting and updating DatFiles
+    /// <summary>
+    /// Helper methods for updating and converting DatFiles
+    /// </summary>
     public class DatFileTool
     {
         #region Logging
diff --git a/SabreTools.DatTools/Modification.cs b/SabreTools.DatTools/Modification.cs
index ce4eb30a..09b4306f 100644
--- a/SabreTools.DatTools/Modification.cs
+++ b/SabreTools.DatTools/Modification.cs
@@ -13,9 +13,11 @@ using SabreTools.Filtering;
 using SabreTools.IO;
 using SabreTools.Logging;
 
-// This file represents all methods related to the Filtering namespace
 namespace SabreTools.DatTools
 {
+    /// <summary>
+    /// Helper methods for cleaning and filtering DatFiles
+    /// </summary>
     public class Modification
     {
         #region Logging
diff --git a/SabreTools.DatTools/Parser.cs b/SabreTools.DatTools/Parser.cs
index 3fd7af55..93f8948b 100644
--- a/SabreTools.DatTools/Parser.cs
+++ b/SabreTools.DatTools/Parser.cs
@@ -8,9 +8,11 @@ using SabreTools.DatItems;
 using SabreTools.IO;
 using SabreTools.Logging;
 
-// This file represents all methods related to parsing from a file
 namespace SabreTools.DatTools
 {
+    /// <summary>
+    /// Helper methods for parsing into DatFiles
+    /// </summary>
     public class Parser
     {
         #region Logging
diff --git a/SabreTools.DatTools/Rebuilder.cs b/SabreTools.DatTools/Rebuilder.cs
index d1f9b108..6b025ac0 100644
--- a/SabreTools.DatTools/Rebuilder.cs
+++ b/SabreTools.DatTools/Rebuilder.cs
@@ -13,9 +13,11 @@ using SabreTools.IO;
 using SabreTools.Logging;
 using SabreTools.Skippers;
 
-// This file represents all methods related to rebuilding from a DatFile
 namespace SabreTools.DatTools
 {
+    /// <summary>
+    /// Helper methods for rebuilding from DatFiles
+    /// </summary>
     public class Rebuilder
     {
         #region Logging
diff --git a/SabreTools.DatTools/Splitter.cs b/SabreTools.DatTools/Splitter.cs
index 81bb8f9b..033a3e1d 100644
--- a/SabreTools.DatTools/Splitter.cs
+++ b/SabreTools.DatTools/Splitter.cs
@@ -12,10 +12,12 @@ using SabreTools.IO;
 using SabreTools.Logging;
 using NaturalSort;
 
-// This file represents all methods related to splitting a DatFile into multiple
 namespace SabreTools.DatTools
 {
-    // TODO: Implement Level split
+    /// <summary>
+    /// Helper methods for splitting DatFiles
+    /// </summary>
+    /// <remarks>TODO: Implement Level split</remarks>
     public class Splitter
     {
         #region Logging
diff --git a/SabreTools.DatTools/Statistics.cs b/SabreTools.DatTools/Statistics.cs
index 3a0e570e..036dad93 100644
--- a/SabreTools.DatTools/Statistics.cs
+++ b/SabreTools.DatTools/Statistics.cs
@@ -12,6 +12,10 @@ using SabreTools.Reports;
 
 namespace SabreTools.DatTools
 {
+    /// <summary>
+    /// Helper methods for dealing with DatFile statistics
+    /// </summary>
+    
     public class Statistics
     {
         #region Logging
diff --git a/SabreTools.DatTools/Verification.cs b/SabreTools.DatTools/Verification.cs
index 44bc5d38..c8bc8579 100644
--- a/SabreTools.DatTools/Verification.cs
+++ b/SabreTools.DatTools/Verification.cs
@@ -10,9 +10,11 @@ using SabreTools.FileTypes;
 using SabreTools.FileTypes.Archives;
 using SabreTools.Logging;
 
-// This file represents all methods related to verifying with a DatFile
 namespace SabreTools.DatTools
 {
+    /// <summary>
+    /// Helper methods for verifying data from DatFiles
+    /// </summary>
     public class Verification
     {
         #region Logging
diff --git a/SabreTools.DatTools/Writer.cs b/SabreTools.DatTools/Writer.cs
index 3ed84984..afa757d9 100644
--- a/SabreTools.DatTools/Writer.cs
+++ b/SabreTools.DatTools/Writer.cs
@@ -10,9 +10,11 @@ using SabreTools.IO;
 using SabreTools.Logging;
 using SabreTools.Reports;
 
-// This file represents all methods related to writing to a file
 namespace SabreTools.DatTools
 {
+    /// <summary>
+    /// Helper methods for writing from DatFiles
+    /// </summary>
     public class Writer
     {
         #region Logging