mirror of
https://github.com/claunia/SabreTools.git
synced 2025-12-16 19:14:27 +00:00
Add remarks about application use
This commit is contained in:
@@ -84,6 +84,7 @@ namespace SabreTools.DatFiles
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Create machine to description mapping dictionary
|
/// Create machine to description mapping dictionary
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <remarks>Applies to <see cref="Items"/></remarks>
|
||||||
private IDictionary<string, string> CreateMachineToDescriptionMapping()
|
private IDictionary<string, string> CreateMachineToDescriptionMapping()
|
||||||
{
|
{
|
||||||
#if NET40_OR_GREATER || NETCOREAPP
|
#if NET40_OR_GREATER || NETCOREAPP
|
||||||
@@ -139,6 +140,7 @@ namespace SabreTools.DatFiles
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Create machine to description mapping dictionary
|
/// Create machine to description mapping dictionary
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <remarks>Applies to <see cref="ItemsDB"/></remarks>
|
||||||
private Dictionary<string, string> CreateMachineToDescriptionMappingDB()
|
private Dictionary<string, string> CreateMachineToDescriptionMappingDB()
|
||||||
{
|
{
|
||||||
Dictionary<string, string> mapping = [];
|
Dictionary<string, string> mapping = [];
|
||||||
@@ -165,6 +167,7 @@ namespace SabreTools.DatFiles
|
|||||||
/// Use game descriptions as names, updating cloneof/romof/sampleof
|
/// Use game descriptions as names, updating cloneof/romof/sampleof
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="throwOnError">True if the error that is thrown should be thrown back to the caller, false otherwise</param>
|
/// <param name="throwOnError">True if the error that is thrown should be thrown back to the caller, false otherwise</param>
|
||||||
|
/// <remarks>Applies to <see cref="Items"/></remarks>
|
||||||
private void MachineDescriptionToNameImpl(bool throwOnError = false)
|
private void MachineDescriptionToNameImpl(bool throwOnError = false)
|
||||||
{
|
{
|
||||||
try
|
try
|
||||||
@@ -185,6 +188,7 @@ namespace SabreTools.DatFiles
|
|||||||
/// Use game descriptions as names, updating cloneof/romof/sampleof
|
/// Use game descriptions as names, updating cloneof/romof/sampleof
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="throwOnError">True if the error that is thrown should be thrown back to the caller, false otherwise</param>
|
/// <param name="throwOnError">True if the error that is thrown should be thrown back to the caller, false otherwise</param>
|
||||||
|
/// <remarks>Applies to <see cref="ItemsDB"/></remarks>
|
||||||
private void MachineDescriptionToNameImplDB(bool throwOnError = false)
|
private void MachineDescriptionToNameImplDB(bool throwOnError = false)
|
||||||
{
|
{
|
||||||
try
|
try
|
||||||
@@ -215,6 +219,7 @@ namespace SabreTools.DatFiles
|
|||||||
/// to clone sets based on name, nor does it have the ability to match on the
|
/// to clone sets based on name, nor does it have the ability to match on the
|
||||||
/// Release DatItem type.
|
/// Release DatItem type.
|
||||||
/// </remarks>
|
/// </remarks>
|
||||||
|
/// <remarks>Applies to <see cref="Items"/></remarks>
|
||||||
private void SetOneGamePerRegionImpl(List<string> regionList)
|
private void SetOneGamePerRegionImpl(List<string> regionList)
|
||||||
{
|
{
|
||||||
// If we have null region list, make it empty
|
// If we have null region list, make it empty
|
||||||
@@ -308,6 +313,7 @@ namespace SabreTools.DatFiles
|
|||||||
/// to clone sets based on name, nor does it have the ability to match on the
|
/// to clone sets based on name, nor does it have the ability to match on the
|
||||||
/// Release DatItem type.
|
/// Release DatItem type.
|
||||||
/// </remarks>
|
/// </remarks>
|
||||||
|
/// <remarks>Applies to <see cref="ItemsDB"/></remarks>
|
||||||
private void SetOneGamePerRegionImplDB(List<string> regionList)
|
private void SetOneGamePerRegionImplDB(List<string> regionList)
|
||||||
{
|
{
|
||||||
// If we have null region list, make it empty
|
// If we have null region list, make it empty
|
||||||
@@ -397,6 +403,7 @@ namespace SabreTools.DatFiles
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Ensure that all roms are in their own game (or at least try to ensure)
|
/// Ensure that all roms are in their own game (or at least try to ensure)
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <remarks>Applies to <see cref="Items"/></remarks>
|
||||||
private void SetOneRomPerGameImpl()
|
private void SetOneRomPerGameImpl()
|
||||||
{
|
{
|
||||||
// For each rom, we want to update the game to be "<game name>/<rom name>"
|
// For each rom, we want to update the game to be "<game name>/<rom name>"
|
||||||
@@ -431,6 +438,7 @@ namespace SabreTools.DatFiles
|
|||||||
/// Set internal names to match One Rom Per Game (ORPG) logic
|
/// Set internal names to match One Rom Per Game (ORPG) logic
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="datItem">DatItem to run logic on</param>
|
/// <param name="datItem">DatItem to run logic on</param>
|
||||||
|
/// <remarks>Applies to <see cref="Items"/></remarks>
|
||||||
private static void SetOneRomPerGameImpl(DatItem datItem)
|
private static void SetOneRomPerGameImpl(DatItem datItem)
|
||||||
{
|
{
|
||||||
// If the item name is null
|
// If the item name is null
|
||||||
@@ -462,6 +470,7 @@ namespace SabreTools.DatFiles
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Ensure that all roms are in their own game (or at least try to ensure)
|
/// Ensure that all roms are in their own game (or at least try to ensure)
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <remarks>Applies to <see cref="ItemsDB"/></remarks>
|
||||||
private void SetOneRomPerGameImplDB()
|
private void SetOneRomPerGameImplDB()
|
||||||
{
|
{
|
||||||
// For each rom, we want to update the game to be "<game name>/<rom name>"
|
// For each rom, we want to update the game to be "<game name>/<rom name>"
|
||||||
@@ -496,6 +505,7 @@ namespace SabreTools.DatFiles
|
|||||||
/// Set internal names to match One Rom Per Game (ORPG) logic
|
/// Set internal names to match One Rom Per Game (ORPG) logic
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="datItem">DatItem to run logic on</param>
|
/// <param name="datItem">DatItem to run logic on</param>
|
||||||
|
/// <remarks>Applies to <see cref="ItemsDB"/></remarks>
|
||||||
private void SetOneRomPerGameImplDB(KeyValuePair<long, DatItem> datItem)
|
private void SetOneRomPerGameImplDB(KeyValuePair<long, DatItem> datItem)
|
||||||
{
|
{
|
||||||
// If the item name is null
|
// If the item name is null
|
||||||
@@ -527,6 +537,7 @@ namespace SabreTools.DatFiles
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Strip the dates from the beginning of scene-style set names
|
/// Strip the dates from the beginning of scene-style set names
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <remarks>Applies to <see cref="Items"/></remarks>
|
||||||
private void StripSceneDatesFromItemsImpl()
|
private void StripSceneDatesFromItemsImpl()
|
||||||
{
|
{
|
||||||
// Now process all of the roms
|
// Now process all of the roms
|
||||||
@@ -570,6 +581,7 @@ namespace SabreTools.DatFiles
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Strip the dates from the beginning of scene-style set names
|
/// Strip the dates from the beginning of scene-style set names
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <remarks>Applies to <see cref="ItemsDB"/></remarks>
|
||||||
private void StripSceneDatesFromItemsImplDB()
|
private void StripSceneDatesFromItemsImplDB()
|
||||||
{
|
{
|
||||||
// Now process all of the machines
|
// Now process all of the machines
|
||||||
@@ -604,6 +616,7 @@ namespace SabreTools.DatFiles
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Update machine names from descriptions according to mappings
|
/// Update machine names from descriptions according to mappings
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <remarks>Applies to <see cref="Items"/></remarks>
|
||||||
private void UpdateMachineNamesFromDescriptions(IDictionary<string, string> mapping)
|
private void UpdateMachineNamesFromDescriptions(IDictionary<string, string> mapping)
|
||||||
{
|
{
|
||||||
#if NET452_OR_GREATER || NETCOREAPP
|
#if NET452_OR_GREATER || NETCOREAPP
|
||||||
@@ -661,6 +674,7 @@ namespace SabreTools.DatFiles
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Update machine names from descriptions according to mappings
|
/// Update machine names from descriptions according to mappings
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <remarks>Applies to <see cref="ItemsDB"/></remarks>
|
||||||
private void UpdateMachineNamesFromDescriptionsDB(Dictionary<string, string> mapping)
|
private void UpdateMachineNamesFromDescriptionsDB(Dictionary<string, string> mapping)
|
||||||
{
|
{
|
||||||
foreach (var machine in GetMachinesDB())
|
foreach (var machine in GetMachinesDB())
|
||||||
|
|||||||
Reference in New Issue
Block a user