From 485af5e044cac3ad99a51529376934dec7bddb1f Mon Sep 17 00:00:00 2001
From: games647 <games647@users.noreply.github.com>
Date: Mon, 11 Dec 2023 15:04:03 +0100
Subject: [PATCH] Document states

---
 .../fastlogin/core/shared/FloodgateState.java    | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/core/src/main/java/com/github/games647/fastlogin/core/shared/FloodgateState.java b/core/src/main/java/com/github/games647/fastlogin/core/shared/FloodgateState.java
index caa867fa..9e5df985 100644
--- a/core/src/main/java/com/github/games647/fastlogin/core/shared/FloodgateState.java
+++ b/core/src/main/java/com/github/games647/fastlogin/core/shared/FloodgateState.java
@@ -26,9 +26,25 @@
 package com.github.games647.fastlogin.core.shared;
 
 public enum FloodgateState {
+
+    /**
+     * Purely Java profile
+     */
     FALSE(0),
+
+    /**
+     * Purely Bedrock profile
+     */
     TRUE(1),
+
+    /**
+     * Bedrock profile is bidirectional associated with the Java Mojang profile.
+     */
     LINKED(2),
+
+    /**
+     * Data before floodgate database migration. Floodgate state is unknown.
+     */
     NOT_MIGRATED(3);
 
     private int value;