Add proper block comments to DatTools classes

This commit is contained in:
Matt Nadareski
2020-12-21 11:38:56 -08:00
parent c6ad91ad49
commit d66c92403e
8 changed files with 26 additions and 8 deletions

View File

@@ -11,7 +11,9 @@ using SabreTools.Logging;
namespace SabreTools.DatTools 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 public class DatFileTool
{ {
#region Logging #region Logging

View File

@@ -13,9 +13,11 @@ using SabreTools.Filtering;
using SabreTools.IO; using SabreTools.IO;
using SabreTools.Logging; using SabreTools.Logging;
// This file represents all methods related to the Filtering namespace
namespace SabreTools.DatTools namespace SabreTools.DatTools
{ {
/// <summary>
/// Helper methods for cleaning and filtering DatFiles
/// </summary>
public class Modification public class Modification
{ {
#region Logging #region Logging

View File

@@ -8,9 +8,11 @@ using SabreTools.DatItems;
using SabreTools.IO; using SabreTools.IO;
using SabreTools.Logging; using SabreTools.Logging;
// This file represents all methods related to parsing from a file
namespace SabreTools.DatTools namespace SabreTools.DatTools
{ {
/// <summary>
/// Helper methods for parsing into DatFiles
/// </summary>
public class Parser public class Parser
{ {
#region Logging #region Logging

View File

@@ -13,9 +13,11 @@ using SabreTools.IO;
using SabreTools.Logging; using SabreTools.Logging;
using SabreTools.Skippers; using SabreTools.Skippers;
// This file represents all methods related to rebuilding from a DatFile
namespace SabreTools.DatTools namespace SabreTools.DatTools
{ {
/// <summary>
/// Helper methods for rebuilding from DatFiles
/// </summary>
public class Rebuilder public class Rebuilder
{ {
#region Logging #region Logging

View File

@@ -12,10 +12,12 @@ using SabreTools.IO;
using SabreTools.Logging; using SabreTools.Logging;
using NaturalSort; using NaturalSort;
// This file represents all methods related to splitting a DatFile into multiple
namespace SabreTools.DatTools namespace SabreTools.DatTools
{ {
// TODO: Implement Level split /// <summary>
/// Helper methods for splitting DatFiles
/// </summary>
/// <remarks>TODO: Implement Level split</remarks>
public class Splitter public class Splitter
{ {
#region Logging #region Logging

View File

@@ -12,6 +12,10 @@ using SabreTools.Reports;
namespace SabreTools.DatTools namespace SabreTools.DatTools
{ {
/// <summary>
/// Helper methods for dealing with DatFile statistics
/// </summary>
public class Statistics public class Statistics
{ {
#region Logging #region Logging

View File

@@ -10,9 +10,11 @@ using SabreTools.FileTypes;
using SabreTools.FileTypes.Archives; using SabreTools.FileTypes.Archives;
using SabreTools.Logging; using SabreTools.Logging;
// This file represents all methods related to verifying with a DatFile
namespace SabreTools.DatTools namespace SabreTools.DatTools
{ {
/// <summary>
/// Helper methods for verifying data from DatFiles
/// </summary>
public class Verification public class Verification
{ {
#region Logging #region Logging

View File

@@ -10,9 +10,11 @@ using SabreTools.IO;
using SabreTools.Logging; using SabreTools.Logging;
using SabreTools.Reports; using SabreTools.Reports;
// This file represents all methods related to writing to a file
namespace SabreTools.DatTools namespace SabreTools.DatTools
{ {
/// <summary>
/// Helper methods for writing from DatFiles
/// </summary>
public class Writer public class Writer
{ {
#region Logging #region Logging