diff --git a/PKHeX.Core/Legality/Verifiers/TransferVerifier.cs b/PKHeX.Core/Legality/Verifiers/TransferVerifier.cs index 26f85ecef..c19fde8df 100644 --- a/PKHeX.Core/Legality/Verifiers/TransferVerifier.cs +++ b/PKHeX.Core/Legality/Verifiers/TransferVerifier.cs @@ -5,7 +5,7 @@ namespace PKHeX.Core { /// - /// Verifies the transfer data for a that has been irreversably transferred forward. + /// Verifies the transfer data for a that has been irreversibly transferred forward. /// public sealed class TransferVerifier : Verifier { diff --git a/PKHeX.Core/PKM/Util/Conversion/EntityConverterResult.cs b/PKHeX.Core/PKM/Util/Conversion/EntityConverterResult.cs index cf4824594..f7b601388 100644 --- a/PKHeX.Core/PKM/Util/Conversion/EntityConverterResult.cs +++ b/PKHeX.Core/PKM/Util/Conversion/EntityConverterResult.cs @@ -1,5 +1,8 @@ namespace PKHeX.Core; +/// +/// Indicates the result of an entity conversion attempt. +/// public enum EntityConverterResult { None, diff --git a/PKHeX.Core/PKM/Util/Conversion/EntityRejuvenationSetting.cs b/PKHeX.Core/PKM/Util/Conversion/EntityRejuvenationSetting.cs index 5c205babe..37746b7a2 100644 --- a/PKHeX.Core/PKM/Util/Conversion/EntityRejuvenationSetting.cs +++ b/PKHeX.Core/PKM/Util/Conversion/EntityRejuvenationSetting.cs @@ -1,5 +1,8 @@ namespace PKHeX.Core; +/// +/// Setting to fill in data (rejuvenate) when converting an entity. +/// public enum EntityRejuvenationSetting { Custom = -1, diff --git a/PKHeX.Core/PKM/Util/Conversion/IEntityRejuvenator.cs b/PKHeX.Core/PKM/Util/Conversion/IEntityRejuvenator.cs index 62a89da95..b82330c56 100644 --- a/PKHeX.Core/PKM/Util/Conversion/IEntityRejuvenator.cs +++ b/PKHeX.Core/PKM/Util/Conversion/IEntityRejuvenator.cs @@ -1,14 +1,27 @@ namespace PKHeX.Core; +/// +/// Interface that exposes a method to data after converting. +/// public interface IEntityRejuvenator { - public void Rejuvenate(PKM result, PKM original); + /// + /// After converting, the method will attempt to auto-fill missing properties. + /// + /// Output data after conversion + /// Input data prior to conversion + void Rejuvenate(PKM result, PKM original); } +/// +/// Uses to auto-fill missing data after conversion. +/// public class LegalityRejuvenator : IEntityRejuvenator { public void Rejuvenate(PKM result, PKM original) { + // HOME transfers from PB8/PA8 => PK8 will sanitize Ball & Met/Egg Location. + // Transferring back without a reference PB8/PA8, we need to guess the *original* values. if (original is not PK8 pk8) return; @@ -87,8 +100,3 @@ private static void RejuvenateBDSP(PKM result, PK8 original) } } } - -public sealed class EntityRejuvenatorDummy : IEntityRejuvenator -{ - public void Rejuvenate(PKM result, PKM original) { } -} diff --git a/PKHeX.Core/PKM/Util/EntityFileNamer.cs b/PKHeX.Core/PKM/Util/EntityFileNamer.cs index 4e2e8a223..7c4536513 100644 --- a/PKHeX.Core/PKM/Util/EntityFileNamer.cs +++ b/PKHeX.Core/PKM/Util/EntityFileNamer.cs @@ -15,6 +15,9 @@ public static class EntityFileNamer public static string GetName(PKM pk) => Namer.GetName(pk); } + /// + /// PKHeX's default file naming logic. + /// public sealed class DefaultEntityNamer : IFileNamer { public string GetName(PKM obj) @@ -47,6 +50,10 @@ private static string GetGBPKM(GBPKM gb) } } + /// + /// Exposes a method to get a file name (no extension) for the type. + /// + /// Type that the implementer can create a file name for. public interface IFileNamer { string GetName(T obj); diff --git a/PKHeX.Core/PKM/Util/Experience.cs b/PKHeX.Core/PKM/Util/Experience.cs index 32219ba42..0e4f8e9ca 100644 --- a/PKHeX.Core/PKM/Util/Experience.cs +++ b/PKHeX.Core/PKM/Util/Experience.cs @@ -48,7 +48,7 @@ public static uint GetEXP(int level, int growth) /// /// Current Level /// Growth Rate type - /// Percentage [0,1.00) + /// EXP to level up public static uint GetEXPToLevelUp(int level, int growth) { if (level >= 100)