Add xmldoc

no code changes

PKHeX.Core/Saves/SAV7b.cs

@@ -5,6 +5,9 @@
 
 namespace PKHeX.Core
 {
+    /// <summary>
+    /// Generation 7 <see cref="SaveFile"/> object for <see cref="GameVersion.GG"/> games.
+    /// </summary>
     public sealed class SAV7b : SaveFile, ISecureValueStorage
     {
         protected override string BAKText => $"{OT} ({Version}) - {Played.LastSavedTime}";

PKHeX.Core/Saves/Storage/Bank3.cs

@@ -1,7 +1,7 @@
 namespace PKHeX.Core
 {
     /// <summary>
-    /// PokeStock .gst
+    /// Generation 3 <see cref="SaveFile"/> object that reads exported data for Generation 3 PokeStock .gst dumps.
     /// </summary>
     public sealed class Bank3 : BulkStorage
     {

PKHeX.Core/Saves/Storage/Bank4.cs

@@ -1,7 +1,7 @@
 namespace PKHeX.Core
 {
     /// <summary>
-    /// PokeStock .stk
+    /// Generation 4 <see cref="SaveFile"/> object that reads Generation 4 PokeStock .stk dumps.
     /// </summary>
     public sealed class Bank4 : BulkStorage
     {

PKHeX.Core/Saves/Storage/Bank7.cs

@@ -2,6 +2,9 @@
 
 namespace PKHeX.Core
 {
+    /// <summary>
+    /// Generation 7 <see cref="SaveFile"/> object that reads from Pokémon Bank savedata (stored on AWS).
+    /// </summary>
     public sealed class Bank7 : BulkStorage
     {
         public Bank7(byte[] data, Type t, int start, int slotsPerBox = 30) : base(data, t, start, slotsPerBox)

PKHeX.Core/Saves/Storage/SAV4Ranch.cs

@@ -4,6 +4,9 @@
 
 namespace PKHeX.Core
 {
+    /// <summary>
+    /// Generation 4 <see cref="SaveFile"/> object for My Pokémon Ranch saves.
+    /// </summary>
     public sealed class SAV4Ranch : BulkStorage
     {
         public override int SIZE_STORED => 0x88 + 0x1C;

PKHeX.Core/Saves/Storage/SlotPointerUtil.cs

@@ -3,6 +3,9 @@
 
 namespace PKHeX.Core
 {
+    /// <summary>
+    /// Logic for rearranging pointers for Box Storage utility
+    /// </summary>
     public static class SlotPointerUtil
     {
         private static bool WithinRange(int slot, int min, int max) => min <= slot && slot < max;

PKHeX.Core/Saves/Storage/StorageSlotFlag.cs

@@ -2,6 +2,10 @@
 
 namespace PKHeX.Core
 {
+    /// <summary>
+    /// Flags describing special attributes for a <see cref="PKM"/> based on its origin from the parent <see cref="SaveFile"/>.
+    /// </summary>
+    /// <remarks>If <see cref="None"/>, then it's a nonspecial slot.</remarks>
     [Flags]
     public enum StorageSlotFlag
     {
@@ -31,6 +35,11 @@ public static class StorageSlotFlagExtensions
     {
         public static bool HasFlagFast(this StorageSlotFlag value, StorageSlotFlag flag) => (value & flag) != 0;
 
+        /// <summary>
+        /// Checks to see if the <see cref="StorageSlotFlag"/> prevents the corresponding slot from being overwritten.
+        /// </summary>
+        /// <param name="value">Flag value</param>
+        /// <returns>True if write protected</returns>
         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;
         }
 
+        /// <summary>
+        /// Gets the Battle Team ID the <see cref="value"/> belongs to
+        /// </summary>
+        /// <param name="value">Flag value</param>
+        /// <returns>Battle Team ID if valid, -1 otherwise.</returns>
         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;
         }
 
+        /// <summary>
+        /// Gets the Party Slot Index the <see cref="value"/> belongs to
+        /// </summary>
+        /// <param name="value">Flag value</param>
+        /// <returns>[0,5] if valid, -1 otherwise.</returns>
         public static int IsParty(this StorageSlotFlag value)
         {
             if (value.HasFlagFast(StorageSlotFlag.Party1))

PKHeX.Core/Saves/Substructures/BoxWallpaper.cs

@@ -2,6 +2,9 @@
 
 namespace PKHeX.Core
 {
+    /// <summary>
+    /// Retrieves Box Storage wallpaper metadata.
+    /// </summary>
     public static class BoxWallpaper
     {
         public static string GetWallpaperResourceName(GameVersion version, int index)

PKHeX.Core/Saves/Substructures/Gen7/SaveBlock.cs

@@ -1,5 +1,8 @@
 namespace PKHeX.Core
 {
+    /// <summary>
+    /// Base class for a savegame data reader.
+    /// </summary>
     public abstract class SaveBlock
     {
         public int Offset { get; protected set; }

PKHeX.Core/Saves/Substructures/Inventory/BeanPouch.cs

@@ -4,6 +4,9 @@
 
 namespace PKHeX.Core
 {
+    /// <summary>
+    /// Reads the bean pouch data from a <see cref="SAV7"/>.
+    /// </summary>
     public class BeanPouch
     {
         public const int Count = 15;

PKHeX.Core/Saves/Substructures/MysteryGiftAlbum.cs

@@ -1,12 +1,26 @@
 namespace PKHeX.Core
 {
     /// <summary>
-    /// Structure containing Mystery Gift Block Data
+    /// Structure containing the Mystery Gift Data
     /// </summary>
     public class MysteryGiftAlbum
     {
+        /// <summary>
+        /// Mystery Gift data received
+        /// </summary>
         public MysteryGift[] Gifts;
+
+        /// <summary>
+        /// Received Flag list
+        /// </summary>
+        /// <remarks>
+        /// this[index] == true iff index=<see cref="MysteryGift.CardID"/> has been received already.
+        /// </remarks>
         public bool[] Flags;
+
+        /// <summary>
+        /// Encryption Seed (only used in Generation 4 to encrypt the stored data)
+        /// </summary>
         public uint Seed;
     }
 }

PKHeX.Core/Saves/Substructures/Records.cs

@@ -2,6 +2,9 @@
 
 namespace PKHeX.Core
 {
+    /// <summary>
+    /// <see cref="SaveFile"/> lifetime stat tracking
+    /// </summary>
     public static class Records
     {
         private const int LargeRecordCount = 100;