From ce3900c1b1318e1e0d000da93caa97a440154442 Mon Sep 17 00:00:00 2001 From: Matt Nadareski Date: Mon, 9 Oct 2017 13:08:15 -0700 Subject: [PATCH] [DatFiles/] Add descriptors to each class --- SabreTools.Library/DatFiles/DatFile.ConvertUpdate.cs | 3 +++ SabreTools.Library/DatFiles/DatFile.DFD.cs | 3 +++ SabreTools.Library/DatFiles/DatFile.Manipulate.cs | 3 +++ SabreTools.Library/DatFiles/DatFile.Parsers.cs | 3 +++ SabreTools.Library/DatFiles/DatFile.Rebuild.cs | 3 +++ SabreTools.Library/DatFiles/DatFile.Splitters.cs | 3 +++ SabreTools.Library/DatFiles/DatFile.Statistics.cs | 11 +++++++---- SabreTools.Library/DatFiles/DatFile.Writers.cs | 3 +++ SabreTools.Library/DatFiles/DatFile.cs | 3 +++ SabreTools.Library/DatFiles/DatHeader.cs | 3 +++ SabreTools.Library/DatFiles/DatStats.cs | 3 +++ SabreTools.Library/DatFiles/Filter.cs | 3 +++ 12 files changed, 40 insertions(+), 4 deletions(-) diff --git a/SabreTools.Library/DatFiles/DatFile.ConvertUpdate.cs b/SabreTools.Library/DatFiles/DatFile.ConvertUpdate.cs index 5796807e..a6d82201 100644 --- a/SabreTools.Library/DatFiles/DatFile.ConvertUpdate.cs +++ b/SabreTools.Library/DatFiles/DatFile.ConvertUpdate.cs @@ -18,6 +18,9 @@ using NaturalSort; namespace SabreTools.Library.DatFiles { + /// + /// Represents a format-agnostic DAT + /// public partial class DatFile { #region Converting and Updating diff --git a/SabreTools.Library/DatFiles/DatFile.DFD.cs b/SabreTools.Library/DatFiles/DatFile.DFD.cs index c658f41f..ad14c4a2 100644 --- a/SabreTools.Library/DatFiles/DatFile.DFD.cs +++ b/SabreTools.Library/DatFiles/DatFile.DFD.cs @@ -19,6 +19,9 @@ using SharpCompress.Common; namespace SabreTools.Library.DatFiles { + /// + /// Represents a format-agnostic DAT + /// public partial class DatFile { #region Populate DAT from Directory [MODULAR DONE, FOR NOW] diff --git a/SabreTools.Library/DatFiles/DatFile.Manipulate.cs b/SabreTools.Library/DatFiles/DatFile.Manipulate.cs index f907df5e..10d04658 100644 --- a/SabreTools.Library/DatFiles/DatFile.Manipulate.cs +++ b/SabreTools.Library/DatFiles/DatFile.Manipulate.cs @@ -16,6 +16,9 @@ using Alphaleonis.Win32.Filesystem; namespace SabreTools.Library.DatFiles { + /// + /// Represents a format-agnostic DAT + /// public partial class DatFile { #region Instance Methods diff --git a/SabreTools.Library/DatFiles/DatFile.Parsers.cs b/SabreTools.Library/DatFiles/DatFile.Parsers.cs index ee013700..be845247 100644 --- a/SabreTools.Library/DatFiles/DatFile.Parsers.cs +++ b/SabreTools.Library/DatFiles/DatFile.Parsers.cs @@ -20,6 +20,9 @@ using StreamReader = System.IO.StreamReader; namespace SabreTools.Library.DatFiles { + /// + /// Represents a format-agnostic DAT + /// public partial class DatFile { #region Parsing diff --git a/SabreTools.Library/DatFiles/DatFile.Rebuild.cs b/SabreTools.Library/DatFiles/DatFile.Rebuild.cs index 5da16f3e..5ecbeaef 100644 --- a/SabreTools.Library/DatFiles/DatFile.Rebuild.cs +++ b/SabreTools.Library/DatFiles/DatFile.Rebuild.cs @@ -22,6 +22,9 @@ using Stream = System.IO.Stream; namespace SabreTools.Library.DatFiles { + /// + /// Represents a format-agnostic DAT + /// public partial class DatFile { #region Rebuilding and Verifying [MODULAR DONE, FOR NOW] diff --git a/SabreTools.Library/DatFiles/DatFile.Splitters.cs b/SabreTools.Library/DatFiles/DatFile.Splitters.cs index e82af787..38b230d4 100644 --- a/SabreTools.Library/DatFiles/DatFile.Splitters.cs +++ b/SabreTools.Library/DatFiles/DatFile.Splitters.cs @@ -17,6 +17,9 @@ using NaturalSort; namespace SabreTools.Library.DatFiles { + /// + /// Represents a format-agnostic DAT + /// public partial class DatFile { #region Splitting diff --git a/SabreTools.Library/DatFiles/DatFile.Statistics.cs b/SabreTools.Library/DatFiles/DatFile.Statistics.cs index 19656351..60b9e98c 100644 --- a/SabreTools.Library/DatFiles/DatFile.Statistics.cs +++ b/SabreTools.Library/DatFiles/DatFile.Statistics.cs @@ -19,10 +19,13 @@ using StreamWriter = System.IO.StreamWriter; namespace SabreTools.Library.DatFiles { - /* - * TODO: Make output standard width (HTML, without making the entire thing a table) - * TODO: Multithreading? Either StringBuilder or locking - */ + /// + /// Represents a format-agnostic DAT + /// + /// + /// TODO: Make output standard width (HTML, without making the entire thing a table) + /// TODO: Multithreading? Either StringBuilder or locking + /// public partial class DatFile { #region Instance Methods diff --git a/SabreTools.Library/DatFiles/DatFile.Writers.cs b/SabreTools.Library/DatFiles/DatFile.Writers.cs index 1d00b8b8..bfcf1211 100644 --- a/SabreTools.Library/DatFiles/DatFile.Writers.cs +++ b/SabreTools.Library/DatFiles/DatFile.Writers.cs @@ -22,6 +22,9 @@ using NaturalSort; namespace SabreTools.Library.DatFiles { + /// + /// Represents a format-agnostic DAT + /// public partial class DatFile { #region Writing diff --git a/SabreTools.Library/DatFiles/DatFile.cs b/SabreTools.Library/DatFiles/DatFile.cs index 69b9e83c..899c4af3 100644 --- a/SabreTools.Library/DatFiles/DatFile.cs +++ b/SabreTools.Library/DatFiles/DatFile.cs @@ -6,6 +6,9 @@ using SabreTools.Library.Items; namespace SabreTools.Library.DatFiles { + /// + /// Represents a format-agnostic DAT + /// public partial class DatFile { #region Private instance variables diff --git a/SabreTools.Library/DatFiles/DatHeader.cs b/SabreTools.Library/DatFiles/DatHeader.cs index 948d2f5c..1b0b71b7 100644 --- a/SabreTools.Library/DatFiles/DatHeader.cs +++ b/SabreTools.Library/DatFiles/DatHeader.cs @@ -5,6 +5,9 @@ using SabreTools.Library.Data; namespace SabreTools.Library.DatFiles { + /// + /// Represents all possible DAT header information + /// public class DatHeader : ICloneable { #region Private instance variables diff --git a/SabreTools.Library/DatFiles/DatStats.cs b/SabreTools.Library/DatFiles/DatStats.cs index 170c577e..340166cf 100644 --- a/SabreTools.Library/DatFiles/DatStats.cs +++ b/SabreTools.Library/DatFiles/DatStats.cs @@ -5,6 +5,9 @@ using SabreTools.Library.Items; namespace SabreTools.Library.DatFiles { + /// + /// Represents statistical data associated with a DAT + /// public class DatStats { #region Private instance variables diff --git a/SabreTools.Library/DatFiles/Filter.cs b/SabreTools.Library/DatFiles/Filter.cs index 1ff4dae3..a5d35b37 100644 --- a/SabreTools.Library/DatFiles/Filter.cs +++ b/SabreTools.Library/DatFiles/Filter.cs @@ -7,6 +7,9 @@ using SabreTools.Library.Items; namespace SabreTools.Library.DatFiles { + /// + /// Represents the filtering operations that need to be performed on a set of items, usually a DAT + /// public class Filter { #region Private instance variables