From e96ef76dcd1e5be10ca59c4e580734d43291faa8 Mon Sep 17 00:00:00 2001 From: Kurt Date: Sat, 9 Feb 2019 20:24:38 -0800 Subject: [PATCH] Add xmldoc no code changes --- PKHeX.Core/Saves/SAV7b.cs | 3 +++ PKHeX.Core/Saves/Storage/Bank3.cs | 2 +- PKHeX.Core/Saves/Storage/Bank4.cs | 2 +- PKHeX.Core/Saves/Storage/Bank7.cs | 3 +++ PKHeX.Core/Saves/Storage/SAV4Ranch.cs | 3 +++ PKHeX.Core/Saves/Storage/SlotPointerUtil.cs | 3 +++ PKHeX.Core/Saves/Storage/StorageSlotFlag.cs | 19 +++++++++++++++++++ .../Saves/Substructures/BoxWallpaper.cs | 3 +++ .../Saves/Substructures/Gen7/SaveBlock.cs | 3 +++ .../Substructures/Inventory/BeanPouch.cs | 3 +++ .../Saves/Substructures/MysteryGiftAlbum.cs | 16 +++++++++++++++- PKHeX.Core/Saves/Substructures/Records.cs | 3 +++ 12 files changed, 60 insertions(+), 3 deletions(-) diff --git a/PKHeX.Core/Saves/SAV7b.cs b/PKHeX.Core/Saves/SAV7b.cs index bd31ee8f4..f5b3ec847 100644 --- a/PKHeX.Core/Saves/SAV7b.cs +++ b/PKHeX.Core/Saves/SAV7b.cs @@ -5,6 +5,9 @@ namespace PKHeX.Core { + /// + /// Generation 7 object for games. + /// public sealed class SAV7b : SaveFile, ISecureValueStorage { protected override string BAKText => $"{OT} ({Version}) - {Played.LastSavedTime}"; diff --git a/PKHeX.Core/Saves/Storage/Bank3.cs b/PKHeX.Core/Saves/Storage/Bank3.cs index ed5a0b521..58248396e 100644 --- a/PKHeX.Core/Saves/Storage/Bank3.cs +++ b/PKHeX.Core/Saves/Storage/Bank3.cs @@ -1,7 +1,7 @@ namespace PKHeX.Core { /// - /// PokeStock .gst + /// Generation 3 object that reads exported data for Generation 3 PokeStock .gst dumps. /// public sealed class Bank3 : BulkStorage { diff --git a/PKHeX.Core/Saves/Storage/Bank4.cs b/PKHeX.Core/Saves/Storage/Bank4.cs index ebcc2357a..0ffe45881 100644 --- a/PKHeX.Core/Saves/Storage/Bank4.cs +++ b/PKHeX.Core/Saves/Storage/Bank4.cs @@ -1,7 +1,7 @@ namespace PKHeX.Core { /// - /// PokeStock .stk + /// Generation 4 object that reads Generation 4 PokeStock .stk dumps. /// public sealed class Bank4 : BulkStorage { diff --git a/PKHeX.Core/Saves/Storage/Bank7.cs b/PKHeX.Core/Saves/Storage/Bank7.cs index fbe5ed78d..f1ba45cb9 100644 --- a/PKHeX.Core/Saves/Storage/Bank7.cs +++ b/PKHeX.Core/Saves/Storage/Bank7.cs @@ -2,6 +2,9 @@ namespace PKHeX.Core { + /// + /// Generation 7 object that reads from Pokémon Bank savedata (stored on AWS). + /// public sealed class Bank7 : BulkStorage { public Bank7(byte[] data, Type t, int start, int slotsPerBox = 30) : base(data, t, start, slotsPerBox) diff --git a/PKHeX.Core/Saves/Storage/SAV4Ranch.cs b/PKHeX.Core/Saves/Storage/SAV4Ranch.cs index f295704ad..e6d38602f 100644 --- a/PKHeX.Core/Saves/Storage/SAV4Ranch.cs +++ b/PKHeX.Core/Saves/Storage/SAV4Ranch.cs @@ -4,6 +4,9 @@ namespace PKHeX.Core { + /// + /// Generation 4 object for My Pokémon Ranch saves. + /// public sealed class SAV4Ranch : BulkStorage { public override int SIZE_STORED => 0x88 + 0x1C; diff --git a/PKHeX.Core/Saves/Storage/SlotPointerUtil.cs b/PKHeX.Core/Saves/Storage/SlotPointerUtil.cs index 89731e69e..ed6053385 100644 --- a/PKHeX.Core/Saves/Storage/SlotPointerUtil.cs +++ b/PKHeX.Core/Saves/Storage/SlotPointerUtil.cs @@ -3,6 +3,9 @@ namespace PKHeX.Core { + /// + /// Logic for rearranging pointers for Box Storage utility + /// public static class SlotPointerUtil { private static bool WithinRange(int slot, int min, int max) => min <= slot && slot < max; diff --git a/PKHeX.Core/Saves/Storage/StorageSlotFlag.cs b/PKHeX.Core/Saves/Storage/StorageSlotFlag.cs index cd67d5913..3aaa89955 100644 --- a/PKHeX.Core/Saves/Storage/StorageSlotFlag.cs +++ b/PKHeX.Core/Saves/Storage/StorageSlotFlag.cs @@ -2,6 +2,10 @@ namespace PKHeX.Core { + /// + /// Flags describing special attributes for a based on its origin from the parent . + /// + /// If , then it's a nonspecial slot. [Flags] public enum StorageSlotFlag { @@ -31,6 +35,11 @@ public static class StorageSlotFlagExtensions { public static bool HasFlagFast(this StorageSlotFlag value, StorageSlotFlag flag) => (value & flag) != 0; + /// + /// Checks to see if the prevents the corresponding slot from being overwritten. + /// + /// Flag value + /// True if write protected public static bool IsOverwriteProtected(this StorageSlotFlag value) { if (value.HasFlagFast(StorageSlotFlag.Locked)) @@ -42,6 +51,11 @@ public static bool IsOverwriteProtected(this StorageSlotFlag value) return value.IsBattleTeam() >= 0; } + /// + /// Gets the Battle Team ID the belongs to + /// + /// Flag value + /// Battle Team ID if valid, -1 otherwise. public static int IsBattleTeam(this StorageSlotFlag value) { if (value.HasFlagFast(StorageSlotFlag.BattleTeam1)) @@ -60,6 +74,11 @@ public static int IsBattleTeam(this StorageSlotFlag value) return -1; } + /// + /// Gets the Party Slot Index the belongs to + /// + /// Flag value + /// [0,5] if valid, -1 otherwise. public static int IsParty(this StorageSlotFlag value) { if (value.HasFlagFast(StorageSlotFlag.Party1)) diff --git a/PKHeX.Core/Saves/Substructures/BoxWallpaper.cs b/PKHeX.Core/Saves/Substructures/BoxWallpaper.cs index 6b1a39ac5..635ca4fee 100644 --- a/PKHeX.Core/Saves/Substructures/BoxWallpaper.cs +++ b/PKHeX.Core/Saves/Substructures/BoxWallpaper.cs @@ -2,6 +2,9 @@ namespace PKHeX.Core { + /// + /// Retrieves Box Storage wallpaper metadata. + /// public static class BoxWallpaper { public static string GetWallpaperResourceName(GameVersion version, int index) diff --git a/PKHeX.Core/Saves/Substructures/Gen7/SaveBlock.cs b/PKHeX.Core/Saves/Substructures/Gen7/SaveBlock.cs index 64b2aa89a..d09392a57 100644 --- a/PKHeX.Core/Saves/Substructures/Gen7/SaveBlock.cs +++ b/PKHeX.Core/Saves/Substructures/Gen7/SaveBlock.cs @@ -1,5 +1,8 @@ namespace PKHeX.Core { + /// + /// Base class for a savegame data reader. + /// public abstract class SaveBlock { public int Offset { get; protected set; } diff --git a/PKHeX.Core/Saves/Substructures/Inventory/BeanPouch.cs b/PKHeX.Core/Saves/Substructures/Inventory/BeanPouch.cs index c0aac3ff7..cfb93399f 100644 --- a/PKHeX.Core/Saves/Substructures/Inventory/BeanPouch.cs +++ b/PKHeX.Core/Saves/Substructures/Inventory/BeanPouch.cs @@ -4,6 +4,9 @@ namespace PKHeX.Core { + /// + /// Reads the bean pouch data from a . + /// public class BeanPouch { public const int Count = 15; diff --git a/PKHeX.Core/Saves/Substructures/MysteryGiftAlbum.cs b/PKHeX.Core/Saves/Substructures/MysteryGiftAlbum.cs index 7975b90c4..945f2e7a6 100644 --- a/PKHeX.Core/Saves/Substructures/MysteryGiftAlbum.cs +++ b/PKHeX.Core/Saves/Substructures/MysteryGiftAlbum.cs @@ -1,12 +1,26 @@ namespace PKHeX.Core { /// - /// Structure containing Mystery Gift Block Data + /// Structure containing the Mystery Gift Data /// public class MysteryGiftAlbum { + /// + /// Mystery Gift data received + /// public MysteryGift[] Gifts; + + /// + /// Received Flag list + /// + /// + /// this[index] == true iff index= has been received already. + /// public bool[] Flags; + + /// + /// Encryption Seed (only used in Generation 4 to encrypt the stored data) + /// public uint Seed; } } diff --git a/PKHeX.Core/Saves/Substructures/Records.cs b/PKHeX.Core/Saves/Substructures/Records.cs index 039c1a954..ad8ecc756 100644 --- a/PKHeX.Core/Saves/Substructures/Records.cs +++ b/PKHeX.Core/Saves/Substructures/Records.cs @@ -2,6 +2,9 @@ namespace PKHeX.Core { + /// + /// lifetime stat tracking + /// public static class Records { private const int LargeRecordCount = 100;