Skip to content

Commit 68e2240

Browse files
committed
Cleanup and some documentation
1 parent c861268 commit 68e2240

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

xivModdingFramework/Mods/DataContainers/ModList.cs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
using System.Text;
2323
using xivModdingFramework.General.Enums;
2424
using xivModdingFramework.Helpers;
25-
using xivModdingFramework.Resources;
2625

2726
namespace xivModdingFramework.Mods.DataContainers
2827
{
@@ -117,6 +116,12 @@ public bool IsCustomFile()
117116
return data.modOffset == data.originalOffset;
118117
}
119118

119+
/// <summary>
120+
/// Creates a Mod instance using the provided JSON
121+
/// </summary>
122+
/// <param name="modsJson"></param>
123+
/// <param name="sourceApplication"></param>
124+
/// <returns></returns>
120125
public static Mod MakeModFromJson(ModsJson modsJson, string sourceApplication)
121126
{
122127
return new Mod

xivModdingFramework/Mods/FileTypes/TTMP.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,14 @@ public async Task<int> CreateSimpleModPack(SimpleModPackData modPackData, Direct
336336
return processCount;
337337
}
338338

339+
/// <summary>
340+
/// Creates a backup modpack which retains the original modpacks on import
341+
/// </summary>
342+
/// <param name="backupModpackData">The data that will go into the mod pack</param>
343+
/// <param name="gameDirectory">The game directory</param>
344+
/// <param name="progress">The progress of the mod pack creation</param>
345+
/// <param name="overwriteModpack">Whether or not to overwrite an existing modpack with the same name</param>
346+
/// <returns>The number of mods processed for the mod pack</returns>
339347
public async Task<int> CreateBackupModpack(BackupModPackData backupModpackData, DirectoryInfo gameDirectory, IProgress<(int current, int total, string message)> progress, bool overwriteModpack)
340348
{
341349
var processCount = await Task.Run<int>(() =>

0 commit comments

Comments
 (0)