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 13:05:53 -05:00
parent 2f5c43e9ad
commit 8ec4605725
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -14,6 +14,7 @@ namespace SabreTools.DatFiles
/// <summary> /// <summary>
/// Use romof tags to add items to the children /// Use romof tags to add items to the children
/// </summary> /// </summary>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks>
public void AddItemsFromBios() public void AddItemsFromBios()
{ {
AddItemsFromBiosImpl(); AddItemsFromBiosImpl();
@@ -25,6 +26,7 @@ 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>
public void AddItemsFromChildren(bool subfolder, bool skipDedup) public void AddItemsFromChildren(bool subfolder, bool skipDedup)
{ {
AddItemsFromChildrenImpl(subfolder, skipDedup); AddItemsFromChildrenImpl(subfolder, skipDedup);
@@ -36,6 +38,7 @@ namespace SabreTools.DatFiles
/// </summary> /// </summary>
/// <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>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks>
public bool AddItemsFromDevices(bool dev, bool useSlotOptions) public bool AddItemsFromDevices(bool dev, bool useSlotOptions)
{ {
bool foundnew = AddItemsFromDevicesImpl(dev, useSlotOptions); bool foundnew = AddItemsFromDevicesImpl(dev, useSlotOptions);
@@ -46,6 +49,7 @@ namespace SabreTools.DatFiles
/// <summary> /// <summary>
/// Use cloneof tags to add items to the children, setting the new romof tag in the process /// Use cloneof tags to add items to the children, setting the new romof tag in the process
/// </summary> /// </summary>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks>
public void AddItemsFromParent() public void AddItemsFromParent()
{ {
AddItemsFromParentImpl(); AddItemsFromParentImpl();
@@ -55,6 +59,7 @@ 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>
public void RemoveBiosAndDeviceSets() public void RemoveBiosAndDeviceSets()
{ {
RemoveBiosAndDeviceSetsImpl(); RemoveBiosAndDeviceSetsImpl();
@@ -64,6 +69,7 @@ namespace SabreTools.DatFiles
/// <summary> /// <summary>
/// Use cloneof tags to remove items from the children /// Use cloneof tags to remove items from the children
/// </summary> /// </summary>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks>
public void RemoveItemsFromCloneOfChild() public void RemoveItemsFromCloneOfChild()
{ {
RemoveItemsFromCloneOfChildImpl(); RemoveItemsFromCloneOfChildImpl();
@@ -74,6 +80,7 @@ namespace SabreTools.DatFiles
/// Use romof tags to remove bios items from children /// Use romof tags to remove bios items 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>
public void RemoveItemsFromRomOfChild(bool bios) public void RemoveItemsFromRomOfChild(bool bios)
{ {
RemoveItemsFromRomOfChildImpl(bios); RemoveItemsFromRomOfChildImpl(bios);
@@ -83,6 +90,7 @@ namespace SabreTools.DatFiles
/// <summary> /// <summary>
/// Remove all romof and cloneof tags from all machines /// Remove all romof and cloneof tags from all machines
/// </summary> /// </summary>
/// <remarks>Assumes items are bucketed by <see cref="ItemKey.Machine"/></remarks>
public void RemoveMachineRelationshipTags() public void RemoveMachineRelationshipTags()
{ {
RemoveMachineRelationshipTagsImpl(); RemoveMachineRelationshipTagsImpl();