[Haro] Minor documentation fixes

Kakifrucht · Oct 7, 2019 · 634b16e · 634b16e
1 parent 8824e68
commit 634b16e
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 9 deletions.
diff --git a/HalfminerHaro/src/main/java/de/halfminer/hmh/data/NameHaroPlayer.java b/HalfminerHaro/src/main/java/de/halfminer/hmh/data/NameHaroPlayer.java
@@ -5,6 +5,7 @@
 
 /**
  * Player where only the name is known. Used when a player hasn't joined the server before.
+ * Objects can be created and discarded on demand, as this class does not store any state in memory.
  */
 public class NameHaroPlayer extends YAMLHaroPlayer {
 

diff --git a/HalfminerHaro/src/main/java/de/halfminer/hmh/data/UUIDHaroPlayer.java b/HalfminerHaro/src/main/java/de/halfminer/hmh/data/UUIDHaroPlayer.java
@@ -41,11 +41,6 @@ public Player getBase() {
         return player.getBase().getPlayer();
     }
 
-    /**
-     * Check if player was initialized for the current game.
-     *
-     * @return true if player was initialized before for the current game, else false
-     */
     @Override
     public boolean isInitialized() {
         if (!isAdded()) {
@@ -74,9 +69,6 @@ public void setEliminated(boolean eliminated) {
         getPlayerSection().set(IS_ELIMINATED_KEY, eliminated);
     }
 
-    /**
-     * @return true if the player still has time left to play
-     */
     @Override
     public boolean hasTimeLeft() {
         return getTimeLeftSeconds() > 0;

diff --git a/HalfminerHaro/src/main/java/de/halfminer/hmh/data/YAMLHaroPlayer.java b/HalfminerHaro/src/main/java/de/halfminer/hmh/data/YAMLHaroPlayer.java
@@ -3,7 +3,7 @@
 import org.bukkit.configuration.ConfigurationSection;
 
 /**
- * Extending haro player implementation is backed by a YAML {@link ConfigurationSection}.
+ * Implementations where data is backed by a YAML {@link ConfigurationSection}.
  * Use {@link #getPlayerSection()} to access the players data section.
  */
 abstract class YAMLHaroPlayer implements HaroPlayer {