From 303cfa0967e85109870b67234871860cdd5bb760 Mon Sep 17 00:00:00 2001
From: Chomp <dev@dev.sp-tarkov.com>
Date: Tue, 11 Mar 2025 20:30:41 +0000
Subject: [PATCH] Improved comment for `CalculateLevel`

---
 Libraries/SPTarkov.Server.Core/Services/PlayerService.cs | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/Libraries/SPTarkov.Server.Core/Services/PlayerService.cs b/Libraries/SPTarkov.Server.Core/Services/PlayerService.cs
index f02c3574..80348d8e 100644
--- a/Libraries/SPTarkov.Server.Core/Services/PlayerService.cs
+++ b/Libraries/SPTarkov.Server.Core/Services/PlayerService.cs
@@ -9,10 +9,13 @@ public class PlayerService(
 )
 {
     /// <summary>
-    /// Get level of player
+    /// Calculates the current level of a player based on their accumulated experience points.
+    /// This method iterates through an experience table to determine the highest level achieved
+    /// by comparing the player's experience against cumulative thresholds.
     /// </summary>
     /// <param name="pmcData"> Player profile </param>
-    /// <returns> Level of the player </returns>
+    /// <returns> The calculated level of the player as an integer, or null if the level cannot be determined.
+    /// This value is also assigned to <see cref="PmcData.Info.Level"/> within the provided profile. </returns>
     public int? CalculateLevel(PmcData pmcData)
     {
         var accExp = 0;