Add validation notes to DAT types

This commit is contained in:
Matt Nadareski
2022-11-03 12:35:50 -07:00
parent 212af3a7dd
commit b8e0da44ed
14 changed files with 42 additions and 0 deletions

View File

@@ -15,6 +15,9 @@ namespace SabreTools.DatFiles.Formats
/// <summary> /// <summary>
/// Represents parsing and writing of a Archive.org file list /// Represents parsing and writing of a Archive.org file list
/// </summary> /// </summary>
/// <remarks>
/// TODO: Check and enforce required fields in output
/// </remarks>
internal class ArchiveDotOrg : DatFile internal class ArchiveDotOrg : DatFile
{ {
/// <summary> /// <summary>

View File

@@ -14,6 +14,9 @@ namespace SabreTools.DatFiles.Formats
/// <summary> /// <summary>
/// Represents parsing and writing of an AttractMode DAT /// Represents parsing and writing of an AttractMode DAT
/// </summary> /// </summary>
/// <remarks>
/// TODO: Check and enforce required fields in output
/// </remarks>
internal class AttractMode : DatFile internal class AttractMode : DatFile
{ {
/// <summary> /// <summary>

View File

@@ -15,6 +15,9 @@ namespace SabreTools.DatFiles.Formats
/// <summary> /// <summary>
/// Represents parsing and writing of a ClrMamePro DAT /// Represents parsing and writing of a ClrMamePro DAT
/// </summary> /// </summary>
/// <remarks>
/// TODO: Check and enforce required fields in output
/// </remarks>
internal class ClrMamePro : DatFile internal class ClrMamePro : DatFile
{ {
#region Fields #region Fields

View File

@@ -17,6 +17,9 @@ namespace SabreTools.DatFiles.Formats
/// <summary> /// <summary>
/// Represents parsing and writing of a DosCenter DAT /// Represents parsing and writing of a DosCenter DAT
/// </summary> /// </summary>
/// <remarks>
/// TODO: Check and enforce required fields in output
/// </remarks>
internal class DosCenter : DatFile internal class DosCenter : DatFile
{ {
/// <summary> /// <summary>

View File

@@ -15,6 +15,9 @@ namespace SabreTools.DatFiles.Formats
/// <summary> /// <summary>
/// Represents parsing and writing of an Everdrive SMDB file /// Represents parsing and writing of an Everdrive SMDB file
/// </summary> /// </summary>
/// <remarks>
/// TODO: Check and enforce required fields in output
/// </remarks>
internal class EverdriveSMDB : DatFile internal class EverdriveSMDB : DatFile
{ {
/// <summary> /// <summary>

View File

@@ -13,6 +13,9 @@ namespace SabreTools.DatFiles.Formats
/// <summary> /// <summary>
/// Represents parsing and writing of a hashfile such as an SFV, MD5, or SHA-1 file /// Represents parsing and writing of a hashfile such as an SFV, MD5, or SHA-1 file
/// </summary> /// </summary>
/// <remarks>
/// TODO: Check and enforce required fields in output
/// </remarks>
internal class Hashfile : DatFile internal class Hashfile : DatFile
{ {
// Private instance variables specific to Hashfile DATs // Private instance variables specific to Hashfile DATs

View File

@@ -14,6 +14,9 @@ namespace SabreTools.DatFiles.Formats
/// <summary> /// <summary>
/// Represents parsing and writing of a MAME Listrom DAT /// Represents parsing and writing of a MAME Listrom DAT
/// </summary> /// </summary>
/// <remarks>
/// TODO: Check and enforce required fields in output
/// </remarks>
internal class Listrom : DatFile internal class Listrom : DatFile
{ {
/// <summary> /// <summary>

View File

@@ -18,6 +18,9 @@ namespace SabreTools.DatFiles.Formats
/// <summary> /// <summary>
/// Represents parsing and writing of a Logiqx-derived DAT /// Represents parsing and writing of a Logiqx-derived DAT
/// </summary> /// </summary>
/// <remarks>
/// TODO: Check and enforce required fields in output
/// </remarks>
internal class Logiqx : DatFile internal class Logiqx : DatFile
{ {
// Private instance variables specific to Logiqx DATs // Private instance variables specific to Logiqx DATs

View File

@@ -10,6 +10,9 @@ namespace SabreTools.DatFiles.Formats
/// <summary> /// <summary>
/// Represents parsing and writing of a Missfile /// Represents parsing and writing of a Missfile
/// </summary> /// </summary>
/// <remarks>
/// TODO: Check and enforce required fields in output
/// </remarks>
internal class Missfile : DatFile internal class Missfile : DatFile
{ {
/// <summary> /// <summary>

View File

@@ -16,6 +16,9 @@ namespace SabreTools.DatFiles.Formats
/// <summary> /// <summary>
/// Represents parsing and writing of an OfflineList XML DAT /// Represents parsing and writing of an OfflineList XML DAT
/// </summary> /// </summary>
/// <remarks>
/// TODO: Check and enforce required fields in output
/// </remarks>
internal class OfflineList : DatFile internal class OfflineList : DatFile
{ {
/// <summary> /// <summary>

View File

@@ -16,6 +16,9 @@ namespace SabreTools.DatFiles.Formats
/// <summary> /// <summary>
/// Represents parsing and writing of a openMSX softawre list XML DAT /// Represents parsing and writing of a openMSX softawre list XML DAT
/// </summary> /// </summary>
/// <remarks>
/// TODO: Check and enforce required fields in output
/// </remarks>
internal class OpenMSX : DatFile internal class OpenMSX : DatFile
{ {
/// <summary> /// <summary>

View File

@@ -15,6 +15,9 @@ namespace SabreTools.DatFiles.Formats
/// <summary> /// <summary>
/// Represents parsing and writing of a RomCenter DAT /// Represents parsing and writing of a RomCenter DAT
/// </summary> /// </summary>
/// <remarks>
/// TODO: Check and enforce required fields in output
/// </remarks>
internal class RomCenter : DatFile internal class RomCenter : DatFile
{ {
/// <summary> /// <summary>

View File

@@ -15,6 +15,9 @@ namespace SabreTools.DatFiles.Formats
/// <summary> /// <summary>
/// Represents parsing and writing of a value-separated DAT /// Represents parsing and writing of a value-separated DAT
/// </summary> /// </summary>
/// <remarks>
/// TODO: Check and enforce required fields in output
/// </remarks>
internal class SeparatedValue : DatFile internal class SeparatedValue : DatFile
{ {
// Private instance variables specific to Separated Value DATs // Private instance variables specific to Separated Value DATs

View File

@@ -18,6 +18,9 @@ namespace SabreTools.DatFiles.Formats
/// <summary> /// <summary>
/// Represents parsing and writing of a SoftwareList /// Represents parsing and writing of a SoftwareList
/// </summary> /// </summary>
/// <remarks>
/// TODO: Check and enforce required fields in output
/// </remarks>
internal class SoftwareList : DatFile internal class SoftwareList : DatFile
{ {
/// <summary> /// <summary>