[DatFiles/] Add descriptors to each class

This commit is contained in:
Matt Nadareski
2017-10-09 13:08:15 -07:00
parent 72b89100fa
commit ce3900c1b1
12 changed files with 40 additions and 4 deletions

View File

@@ -18,6 +18,9 @@ using NaturalSort;
namespace SabreTools.Library.DatFiles namespace SabreTools.Library.DatFiles
{ {
/// <summary>
/// Represents a format-agnostic DAT
/// </summary>
public partial class DatFile public partial class DatFile
{ {
#region Converting and Updating #region Converting and Updating

View File

@@ -19,6 +19,9 @@ using SharpCompress.Common;
namespace SabreTools.Library.DatFiles namespace SabreTools.Library.DatFiles
{ {
/// <summary>
/// Represents a format-agnostic DAT
/// </summary>
public partial class DatFile public partial class DatFile
{ {
#region Populate DAT from Directory [MODULAR DONE, FOR NOW] #region Populate DAT from Directory [MODULAR DONE, FOR NOW]

View File

@@ -16,6 +16,9 @@ using Alphaleonis.Win32.Filesystem;
namespace SabreTools.Library.DatFiles namespace SabreTools.Library.DatFiles
{ {
/// <summary>
/// Represents a format-agnostic DAT
/// </summary>
public partial class DatFile public partial class DatFile
{ {
#region Instance Methods #region Instance Methods

View File

@@ -20,6 +20,9 @@ using StreamReader = System.IO.StreamReader;
namespace SabreTools.Library.DatFiles namespace SabreTools.Library.DatFiles
{ {
/// <summary>
/// Represents a format-agnostic DAT
/// </summary>
public partial class DatFile public partial class DatFile
{ {
#region Parsing #region Parsing

View File

@@ -22,6 +22,9 @@ using Stream = System.IO.Stream;
namespace SabreTools.Library.DatFiles namespace SabreTools.Library.DatFiles
{ {
/// <summary>
/// Represents a format-agnostic DAT
/// </summary>
public partial class DatFile public partial class DatFile
{ {
#region Rebuilding and Verifying [MODULAR DONE, FOR NOW] #region Rebuilding and Verifying [MODULAR DONE, FOR NOW]

View File

@@ -17,6 +17,9 @@ using NaturalSort;
namespace SabreTools.Library.DatFiles namespace SabreTools.Library.DatFiles
{ {
/// <summary>
/// Represents a format-agnostic DAT
/// </summary>
public partial class DatFile public partial class DatFile
{ {
#region Splitting #region Splitting

View File

@@ -19,10 +19,13 @@ using StreamWriter = System.IO.StreamWriter;
namespace SabreTools.Library.DatFiles namespace SabreTools.Library.DatFiles
{ {
/* /// <summary>
* TODO: Make output standard width (HTML, without making the entire thing a table) /// Represents a format-agnostic DAT
* TODO: Multithreading? Either StringBuilder or locking /// </summary>
*/ /// <remarks>
/// TODO: Make output standard width (HTML, without making the entire thing a table)
/// TODO: Multithreading? Either StringBuilder or locking
/// </remarks>
public partial class DatFile public partial class DatFile
{ {
#region Instance Methods #region Instance Methods

View File

@@ -22,6 +22,9 @@ using NaturalSort;
namespace SabreTools.Library.DatFiles namespace SabreTools.Library.DatFiles
{ {
/// <summary>
/// Represents a format-agnostic DAT
/// </summary>
public partial class DatFile public partial class DatFile
{ {
#region Writing #region Writing

View File

@@ -6,6 +6,9 @@ using SabreTools.Library.Items;
namespace SabreTools.Library.DatFiles namespace SabreTools.Library.DatFiles
{ {
/// <summary>
/// Represents a format-agnostic DAT
/// </summary>
public partial class DatFile public partial class DatFile
{ {
#region Private instance variables #region Private instance variables

View File

@@ -5,6 +5,9 @@ using SabreTools.Library.Data;
namespace SabreTools.Library.DatFiles namespace SabreTools.Library.DatFiles
{ {
/// <summary>
/// Represents all possible DAT header information
/// </summary>
public class DatHeader : ICloneable public class DatHeader : ICloneable
{ {
#region Private instance variables #region Private instance variables

View File

@@ -5,6 +5,9 @@ using SabreTools.Library.Items;
namespace SabreTools.Library.DatFiles namespace SabreTools.Library.DatFiles
{ {
/// <summary>
/// Represents statistical data associated with a DAT
/// </summary>
public class DatStats public class DatStats
{ {
#region Private instance variables #region Private instance variables

View File

@@ -7,6 +7,9 @@ using SabreTools.Library.Items;
namespace SabreTools.Library.DatFiles namespace SabreTools.Library.DatFiles
{ {
/// <summary>
/// Represents the filtering operations that need to be performed on a set of items, usually a DAT
/// </summary>
public class Filter public class Filter
{ {
#region Private instance variables #region Private instance variables