Rename and better document

This commit is contained in:
Matt Nadareski
2016-04-19 00:14:14 -07:00
parent 75d89a2cde
commit 06517988b5
3 changed files with 11 additions and 5 deletions

View File

@@ -76,7 +76,7 @@
<Compile Include="Output.cs" />
<Compile Include="Properties\AssemblyInfo.cs" />
<Compile Include="Remapping.cs" />
<Compile Include="Sort.cs" />
<Compile Include="Sorting.cs" />
<Compile Include="Structs.cs" />
<Compile Include="Style.cs" />
<Compile Include="Build.cs" />

View File

@@ -3,9 +3,15 @@ using System.Collections.Generic;
namespace SabreTools.Helper
{
public class Sort
public class Sorting
{
public static List<RomData> Merge(List<RomData> inroms, bool presorted = false)
/// <summary>
/// Merge an arbitrary set of ROMs based on the supplied information
/// </summary>
/// <param name="inroms">List of RomData objects representing the roms to be merged</param>
/// <param name="presorted">True if the list should be considered pre-sorted (default false)</param>
/// <returns>A List of RomData objects representing the merged roms</returns>
public static List<RomData> RomMerge(List<RomData> inroms, bool presorted = false)
{
List<RomData> outroms = new List<RomData>();