From aaee6c8ce9277dd57733cec268c7349ed0361320 Mon Sep 17 00:00:00 2001
From: Rainnny7 <braydonrainnny@gmail.com>
Date: Sat, 6 Apr 2024 15:25:33 -0400
Subject: [PATCH] Doc changes

---
 .../me/braydon/mc/repository/PlayerCacheRepository.java     | 3 +--
 src/main/java/me/braydon/mc/service/MojangService.java      | 6 ++++++
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/src/main/java/me/braydon/mc/repository/PlayerCacheRepository.java b/src/main/java/me/braydon/mc/repository/PlayerCacheRepository.java
index 2062501..9ddcca8 100644
--- a/src/main/java/me/braydon/mc/repository/PlayerCacheRepository.java
+++ b/src/main/java/me/braydon/mc/repository/PlayerCacheRepository.java
@@ -1,13 +1,12 @@
 package me.braydon.mc.repository;
 
-import me.braydon.mc.model.Player;
 import me.braydon.mc.model.cache.CachedPlayer;
 import org.springframework.data.repository.CrudRepository;
 
 import java.util.UUID;
 
 /**
- * A cache repository for {@link Player}'s.
+ * A cache repository for {@link CachedPlayer}'s.
  *
  * @author Braydon
  */
diff --git a/src/main/java/me/braydon/mc/service/MojangService.java b/src/main/java/me/braydon/mc/service/MojangService.java
index 70d7b83..ac5b500 100644
--- a/src/main/java/me/braydon/mc/service/MojangService.java
+++ b/src/main/java/me/braydon/mc/service/MojangService.java
@@ -45,6 +45,12 @@ public final class MojangService {
 
     /**
      * Get a player by their username or UUID.
+     * <p>
+     * If the player is present within the cache, that will
+     * be returned. If the player is not cached, a request
+     * will be made to retrieve the player from Mojang, cache it
+     * and then return the response.
+     * </p>
      *
      * @param query the query to search for the player by
      * @return the player