From 08900d589c7348fdb979ae4d2514c5dc57cdee80 Mon Sep 17 00:00:00 2001
From: Archit Date <architdate@gmail.com>
Date: Mon, 8 Feb 2021 21:21:22 +0800
Subject: [PATCH] some xml documentation

---
 PKHeX.Core.AutoMod/AutoMod/APILegality.cs | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/PKHeX.Core.AutoMod/AutoMod/APILegality.cs b/PKHeX.Core.AutoMod/AutoMod/APILegality.cs
index d1e49d14..7ca1dedc 100644
--- a/PKHeX.Core.AutoMod/AutoMod/APILegality.cs
+++ b/PKHeX.Core.AutoMod/AutoMod/APILegality.cs
@@ -473,6 +473,10 @@ private static void HandleEggEncounters(this PKM pk, IEncounterable enc, ITraine
             pk.Egg_Location = Locations.TradedEggLocation(pk.Generation);
         }
 
+        /// <summary>
+        /// Sets a tracker based on the setting provided
+        /// </summary>
+        /// <param name="pk">pk to set the tracker for</param>
         private static void GetSuggestedTracker(this PKM pk)
         {
             if (pk is not IHomeTrack home)
@@ -540,6 +544,12 @@ private static void SetIVsPID(this PKM pk, IBattleTemplate set, PIDType method,
             }
         }
 
+        /// <summary>
+        /// Set PIDIV for raid PKM via XOROSHIRO incase it is transferred to future generations to preserve the IVs
+        /// </summary>
+        /// <param name="pk">Pokemon to be edited</param>
+        /// <param name="enc">Raid encounter encounterable</param>
+        /// <param name="set">Set to pass in requested IVs</param>
         private static void PreSetPIDIV(this PKM pk, IEncounterable enc, IBattleTemplate set)
         {
             if (enc is EncounterStatic8N or EncounterStatic8NC or EncounterStatic8ND or EncounterStatic8U)
@@ -614,6 +624,13 @@ private static void FindNestPIDIV<T>(PK8 pk, T enc, bool shiny) where T : Encoun
             pk.StatNature = iterPKM.StatNature;
         }
 
+        /// <summary>
+        /// Exit Criteria for IVs to be valid
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="pk">Pokemon to edit</param>
+        /// <param name="template">Clone of the PKM taken prior</param>
+        /// <returns>True if the IVs are matching the criteria</returns>
         private static bool IsMatchCriteria<T>(PK8 pk, PKM template) where T : EncounterStatic8Nest<T>
         {
             if (template.Nature != pk.Nature) // match nature
@@ -837,6 +854,9 @@ AsyncLegalizationResult GetLegal()
             return result.Created;
         }
 
+        /// <summary>
+        /// Async Related actions for global timer.
+        /// </summary>
         private class AsyncLegalizationResult
         {
             public readonly PKM Created;