diff --git a/AM2RPortHelperLib/RawModsBase.cs b/AM2RPortHelperLib/RawModsBase.cs index c591c3f..91c571d 100644 --- a/AM2RPortHelperLib/RawModsBase.cs +++ b/AM2RPortHelperLib/RawModsBase.cs @@ -14,8 +14,12 @@ public abstract class RawModsBase : ModsBase // For completionist sake, it should be possible to also port raw APKs to win/lin/mac // But until some person actually shows up that needs this feature, I'm too lazy to implement it - // TODO: documentation - + /// + /// Determines for which OS a raw mod zip was made for. + /// + /// The path to the raw mod zip. + /// The OS for which the zip was made for as . + /// The OS for which the zip was made for could not be determined. public static ModOS GetModOSOfRawZip(string inputRawZipPath) { ZipArchive archive = ZipFile.OpenRead(inputRawZipPath); @@ -32,6 +36,12 @@ public abstract class RawModsBase : ModsBase throw new NotSupportedException("The OS of the mod zip is unknown and thus not supported"); } + /// + /// + /// + /// + /// + /// private static string GetProperPathToBuiltinIcons(string nameOfResource) { string SubCaseFunction(string resource) @@ -71,6 +81,13 @@ public abstract class RawModsBase : ModsBase } + /// + /// Ports a raw AM2R mod zip for Linux. + /// + /// The path to the raw mod zip. + /// The path where the ported Linux mod zip should be saved to. + /// A delegate to post output info to. + /// The raw mod zip was made for an OS that can't be determined. public static void PortToLinux(string inputRawZipPath, string outputRawZipPath, OutputHandlerDelegate outputDelegate = null) { ModOS currentOS = GetModOSOfRawZip(inputRawZipPath); @@ -132,6 +149,16 @@ public abstract class RawModsBase : ModsBase Directory.Delete(TempDir, true); } + /// + /// Ports a raw AM2R mod zip for Android. + /// + /// The path to the raw mod zip. + /// The path where the ported Android mod apk should be saved to. + /// Whether the mod should use a custom save location on Android. + /// Whether the mod needs an Internet connection. + /// A delegate to post output info to. + /// The raw mod zip was made for an OS that can't be determined. + /// was given, but the display name of the mod is unsuitable as a name for the directory. public static void PortToAndroid(string inputRawZipPath, string outputRawApkPath, bool useCustomSaveDirectory = false, bool usesInternet = false, OutputHandlerDelegate outputDelegate = null) { ModOS currentOS = GetModOSOfRawZip(inputRawZipPath); @@ -310,6 +337,13 @@ public abstract class RawModsBase : ModsBase Directory.Delete(TempDir, true); } + /// + /// Ports a raw AM2R mod zip for macOS. + /// + /// The path to the raw mod zip. + /// he path where the ported Mac mod zip should be saved to. + /// A delegate to post output info to. + /// The raw mod zip was made for an OS that can't be determined. public static void PortToMac(string inputRawZipPath, string outputRawZipPath, OutputHandlerDelegate outputDelegate = null) { ModOS currentOS = GetModOSOfRawZip(inputRawZipPath);