From 3b64f457bd9055f2d108007438589521744cc99d Mon Sep 17 00:00:00 2001
From: ProSavage <naman0311@gmail.com>
Date: Tue, 28 Aug 2018 21:08:09 -0500
Subject: [PATCH] Started on documenting the methods for the API

---
 .../com/massivecraft/factions/FPlayer.java    | 43 ++++++++++++++++++-
 1 file changed, 42 insertions(+), 1 deletion(-)

diff --git a/src/main/java/com/massivecraft/factions/FPlayer.java b/src/main/java/com/massivecraft/factions/FPlayer.java
index 46bccc4e..8fd04691 100644
--- a/src/main/java/com/massivecraft/factions/FPlayer.java
+++ b/src/main/java/com/massivecraft/factions/FPlayer.java
@@ -28,22 +28,63 @@ import java.util.List;
 
 public interface FPlayer extends EconomyParticipator {
 
+    /**
+     * Used to know if stealth is toggled on or off
+     *
+     * @return if stealth mode is on or not.
+     */
     boolean isStealthEnabled();
 
-    void setStealth(boolean isStealthEnabled);
+    /**
+     * Toggles the stealth of the FPlayer depending on the parameter
+     *
+     * @param stealthToggle
+     */
+    void setStealth(boolean stealthToggle);
 
+    /**
+     * Sets the kills and deaths of a player.
+     */
     void login();
 
+    /**
+     * Caches the kills and deaths of a player.
+     */
     void logout();
 
+    /**
+     * gets the faction of a FPlayer.
+     *
+     * @return Faction of the FPlayer.
+     */
     Faction getFaction();
 
+    /**
+     * Sets the faction of the FPlayer
+     *
+     * @param faction
+     */
     void setFaction(Faction faction);
 
+    /**
+     * Gets the faction ID of the player.
+     *
+     * @return FactionsID string
+     */
     String getFactionId();
 
+    /**
+     * Check if a player has a faction
+     *
+     * @return boolean
+     */
     boolean hasFaction();
 
+    /**
+     * Gets autoleave status
+     *
+     * @return boolean of the autoleave
+     */
     boolean willAutoLeave();
 
     void setAutoLeave(boolean autoLeave);