claunia/SabreTools
1
0
Fork 0
mirror of https://github.com/claunia/SabreTools.git synced 2025-12-16 19:14:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Be more consistent with remarks

Browse Source
This commit is contained in:
Matt Nadareski
2025-01-13 09:27:01 -05:00
parent 3dfd8a38b0
commit 3c4de2cc07
1 changed files with 56 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
SabreTools.DatFiles/DatFile.Splitting.cs
View File

@@ -97,7 +97,10 @@ namespace SabreTools.DatFiles
/// <summary> /// <summary>
/// Use romof tags to add roms to the children /// Use romof tags to add roms to the children
/// </summary> /// </summary>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks> /// <remarks>
/// Applies to <see cref="Items"/>.
/// Assumes items are bucketed by <see cref="ItemKey.Machine"/>.
/// </remarks>
private void AddRomsFromBiosImpl() private void AddRomsFromBiosImpl()
{ {
List<string> buckets = [.. Items.Keys]; List<string> buckets = [.. Items.Keys];
@@ -140,7 +143,10 @@ namespace SabreTools.DatFiles
/// <summary> /// <summary>
/// Use romof tags to add roms to the children /// Use romof tags to add roms to the children
/// </summary> /// </summary>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks> /// <remarks>
/// Applies to <see cref="ItemsDB"/>.
/// Assumes items are bucketed by <see cref="ItemKey.Machine"/>.
/// </remarks>
private void AddRomsFromBiosImplDB() private void AddRomsFromBiosImplDB()
{ {
List<string> buckets = [.. ItemsDB.SortedKeys]; List<string> buckets = [.. ItemsDB.SortedKeys];
@@ -187,7 +193,10 @@ namespace SabreTools.DatFiles
/// </summary> /// </summary>
/// <param name="subfolder">True to add DatItems to subfolder of parent (not including Disk), false otherwise</param> /// <param name="subfolder">True to add DatItems to subfolder of parent (not including Disk), false otherwise</param>
/// <param name="skipDedup">True to skip checking for duplicate ROMs in parent, false otherwise</param> /// <param name="skipDedup">True to skip checking for duplicate ROMs in parent, false otherwise</param>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks> /// <remarks>
/// Applies to <see cref="Items"/>.
/// Assumes items are bucketed by <see cref="ItemKey.Machine"/>.
/// </remarks>
private void AddRomsFromChildrenImpl(bool subfolder, bool skipDedup) private void AddRomsFromChildrenImpl(bool subfolder, bool skipDedup)
{ {
List<string> buckets = [.. Items.Keys]; List<string> buckets = [.. Items.Keys];
@@ -316,7 +325,10 @@ namespace SabreTools.DatFiles
/// </summary> /// </summary>
/// <param name="subfolder">True to add DatItems to subfolder of parent (not including Disk), false otherwise</param> /// <param name="subfolder">True to add DatItems to subfolder of parent (not including Disk), false otherwise</param>
/// <param name="skipDedup">True to skip checking for duplicate ROMs in parent, false otherwise</param> /// <param name="skipDedup">True to skip checking for duplicate ROMs in parent, false otherwise</param>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks> /// <remarks>
/// Applies to <see cref="ItemsDB"/>.
/// Assumes items are bucketed by <see cref="ItemKey.Machine"/>.
/// </remarks>
private void AddRomsFromChildrenImplDB(bool subfolder, bool skipDedup) private void AddRomsFromChildrenImplDB(bool subfolder, bool skipDedup)
{ {
List<string> buckets = [.. ItemsDB.SortedKeys]; List<string> buckets = [.. ItemsDB.SortedKeys];
@@ -447,7 +459,10 @@ namespace SabreTools.DatFiles
/// <param name="dev">True if only child device sets are touched, false for non-device sets (default)</param> /// <param name="dev">True if only child device sets are touched, false for non-device sets (default)</param>
/// <param name="useSlotOptions">True if slotoptions tags are used as well, false otherwise</param> /// <param name="useSlotOptions">True if slotoptions tags are used as well, false otherwise</param>
/// <returns>True if any items were processed, false otherwise</returns> /// <returns>True if any items were processed, false otherwise</returns>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks> /// <remarks>
/// Applies to <see cref="Items"/>.
/// Assumes items are bucketed by <see cref="ItemKey.Machine"/>.
/// </remarks>
private bool AddRomsFromDevicesImpl(bool dev, bool useSlotOptions) private bool AddRomsFromDevicesImpl(bool dev, bool useSlotOptions)
{ {
bool foundnew = false; bool foundnew = false;
@@ -600,7 +615,10 @@ namespace SabreTools.DatFiles
/// <param name="dev">True if only child device sets are touched, false for non-device sets</param> /// <param name="dev">True if only child device sets are touched, false for non-device sets</param>
/// <param name="useSlotOptions">True if slotoptions tags are used as well, false otherwise</param> /// <param name="useSlotOptions">True if slotoptions tags are used as well, false otherwise</param>
/// <returns>True if any items were processed, false otherwise</returns> /// <returns>True if any items were processed, false otherwise</returns>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks> /// <remarks>
/// Applies to <see cref="ItemsDB"/>.
/// Assumes items are bucketed by <see cref="ItemKey.Machine"/>.
/// </remarks>
private bool AddRomsFromDevicesImplDB(bool dev, bool useSlotOptions) private bool AddRomsFromDevicesImplDB(bool dev, bool useSlotOptions)
{ {
bool foundnew = false; bool foundnew = false;
@@ -763,7 +781,10 @@ namespace SabreTools.DatFiles
/// <summary> /// <summary>
/// Use cloneof tags to add roms to the children, setting the new romof tag in the process /// Use cloneof tags to add roms to the children, setting the new romof tag in the process
/// </summary> /// </summary>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks> /// <remarks>
/// Applies to <see cref="Items"/>.
/// Assumes items are bucketed by <see cref="ItemKey.Machine"/>.
/// </remarks>
private void AddRomsFromParentImpl() private void AddRomsFromParentImpl()
{ {
List<string> buckets = [.. Items.Keys]; List<string> buckets = [.. Items.Keys];
@@ -817,7 +838,10 @@ namespace SabreTools.DatFiles
/// <summary> /// <summary>
/// Use cloneof tags to add roms to the children, setting the new romof tag in the process /// Use cloneof tags to add roms to the children, setting the new romof tag in the process
/// </summary> /// </summary>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks> /// <remarks>
/// Applies to <see cref="ItemsDB"/>.
/// Assumes items are bucketed by <see cref="ItemKey.Machine"/>.
/// </remarks>
private void AddRomsFromParentImplDB() private void AddRomsFromParentImplDB()
{ {
List<string> buckets = [.. ItemsDB.SortedKeys]; List<string> buckets = [.. ItemsDB.SortedKeys];
@@ -879,7 +903,10 @@ namespace SabreTools.DatFiles
/// <summary> /// <summary>
/// Remove all BIOS and device sets /// Remove all BIOS and device sets
/// </summary> /// </summary>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks> /// <remarks>
/// Applies to <see cref="Items"/>.
/// Assumes items are bucketed by <see cref="ItemKey.Machine"/>.
/// </remarks>
private void RemoveBiosAndDeviceSetsImpl() private void RemoveBiosAndDeviceSetsImpl()
{ {
List<string> buckets = [.. Items.Keys]; List<string> buckets = [.. Items.Keys];
@@ -909,7 +936,10 @@ namespace SabreTools.DatFiles
/// <summary> /// <summary>
/// Remove all BIOS and device sets /// Remove all BIOS and device sets
/// </summary> /// </summary>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks> /// <remarks>
/// Applies to <see cref="ItemsDB"/>.
/// Assumes items are bucketed by <see cref="ItemKey.Machine"/>.
/// </remarks>
private void RemoveBiosAndDeviceSetsImplDB() private void RemoveBiosAndDeviceSetsImplDB()
{ {
List<string> buckets = [.. ItemsDB.SortedKeys]; List<string> buckets = [.. ItemsDB.SortedKeys];
@@ -941,7 +971,10 @@ namespace SabreTools.DatFiles
/// Use romof tags to remove bios roms from children /// Use romof tags to remove bios roms from children
/// </summary> /// </summary>
/// <param name="bios">True if only child Bios sets are touched, false for non-bios sets</param> /// <param name="bios">True if only child Bios sets are touched, false for non-bios sets</param>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks> /// <remarks>
/// Applies to <see cref="Items"/>.
/// Assumes items are bucketed by <see cref="ItemKey.Machine"/>.
/// </remarks>
private void RemoveBiosRomsFromChildImpl(bool bios) private void RemoveBiosRomsFromChildImpl(bool bios)
{ {
// Loop through the romof tags // Loop through the romof tags
@@ -990,7 +1023,10 @@ namespace SabreTools.DatFiles
/// Use romof tags to remove bios roms from children /// Use romof tags to remove bios roms from children
/// </summary> /// </summary>
/// <param name="bios">True if only child Bios sets are touched, false for non-bios sets</param> /// <param name="bios">True if only child Bios sets are touched, false for non-bios sets</param>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks> /// <remarks>
/// Applies to <see cref="ItemsDB"/>.
/// Assumes items are bucketed by <see cref="ItemKey.Machine"/>.
/// </remarks>
internal void RemoveBiosRomsFromChildImplDB(bool bios) internal void RemoveBiosRomsFromChildImplDB(bool bios)
{ {
// Loop through the romof tags // Loop through the romof tags
@@ -1036,7 +1072,10 @@ namespace SabreTools.DatFiles
/// <summary> /// <summary>
/// Use cloneof tags to remove roms from the children /// Use cloneof tags to remove roms from the children
/// </summary> /// </summary>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks> /// <remarks>
/// Applies to <see cref="Items"/>.
/// Assumes items are bucketed by <see cref="ItemKey.Machine"/>.
/// </remarks>
private void RemoveRomsFromChildImpl() private void RemoveRomsFromChildImpl()
{ {
List<string> buckets = [.. Items.Keys]; List<string> buckets = [.. Items.Keys];
@@ -1087,7 +1126,10 @@ namespace SabreTools.DatFiles
/// <summary> /// <summary>
/// Use cloneof tags to remove roms from the children /// Use cloneof tags to remove roms from the children
/// </summary> /// </summary>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks> /// <remarks>
/// Applies to <see cref="ItemsDB"/>.
/// Assumes items are bucketed by <see cref="ItemKey.Machine"/>.
/// </remarks>
internal void RemoveRomsFromChildImplDB() internal void RemoveRomsFromChildImplDB()
{ {
List<string> buckets = [.. ItemsDB.SortedKeys]; List<string> buckets = [.. ItemsDB.SortedKeys];