From 55270702a5ceed39ce1240be2e584ba60329e7e6 Mon Sep 17 00:00:00 2001
From: games647 <games647@users.noreply.github.com>
Date: Thu, 3 Mar 2022 10:56:28 +0100
Subject: [PATCH] Document event behavior that is platform specific

---
 .../fastlogin/core/shared/event/FastLoginAutoLoginEvent.java   | 3 +++
 .../fastlogin/core/shared/event/FastLoginPreLoginEvent.java    | 3 +++
 .../core/shared/event/FastLoginPremiumToggleEvent.java         | 3 +++
 3 files changed, 9 insertions(+)

diff --git a/core/src/main/java/com/github/games647/fastlogin/core/shared/event/FastLoginAutoLoginEvent.java b/core/src/main/java/com/github/games647/fastlogin/core/shared/event/FastLoginAutoLoginEvent.java
index 817742f7..590f86e8 100644
--- a/core/src/main/java/com/github/games647/fastlogin/core/shared/event/FastLoginAutoLoginEvent.java
+++ b/core/src/main/java/com/github/games647/fastlogin/core/shared/event/FastLoginAutoLoginEvent.java
@@ -28,6 +28,9 @@ package com.github.games647.fastlogin.core.shared.event;
 import com.github.games647.fastlogin.core.StoredProfile;
 import com.github.games647.fastlogin.core.shared.LoginSession;
 
+/**
+ * This event fires if the plugin performs an auto login on the platform where the login plugin is.
+ */
 public interface FastLoginAutoLoginEvent extends FastLoginCancellableEvent {
     LoginSession getSession();
     StoredProfile getProfile();
diff --git a/core/src/main/java/com/github/games647/fastlogin/core/shared/event/FastLoginPreLoginEvent.java b/core/src/main/java/com/github/games647/fastlogin/core/shared/event/FastLoginPreLoginEvent.java
index c8873a86..229ec956 100644
--- a/core/src/main/java/com/github/games647/fastlogin/core/shared/event/FastLoginPreLoginEvent.java
+++ b/core/src/main/java/com/github/games647/fastlogin/core/shared/event/FastLoginPreLoginEvent.java
@@ -28,6 +28,9 @@ package com.github.games647.fastlogin.core.shared.event;
 import com.github.games647.fastlogin.core.StoredProfile;
 import com.github.games647.fastlogin.core.shared.LoginSource;
 
+/**
+ * This action represents the login attempt of a player before the plugin makes any online mode actions.
+ */
 public interface FastLoginPreLoginEvent {
 
     String getUsername();
diff --git a/core/src/main/java/com/github/games647/fastlogin/core/shared/event/FastLoginPremiumToggleEvent.java b/core/src/main/java/com/github/games647/fastlogin/core/shared/event/FastLoginPremiumToggleEvent.java
index 5c5ce469..e090328b 100644
--- a/core/src/main/java/com/github/games647/fastlogin/core/shared/event/FastLoginPremiumToggleEvent.java
+++ b/core/src/main/java/com/github/games647/fastlogin/core/shared/event/FastLoginPremiumToggleEvent.java
@@ -27,6 +27,9 @@ package com.github.games647.fastlogin.core.shared.event;
 
 import com.github.games647.fastlogin.core.StoredProfile;
 
+/**
+ * This even represents the opt-in premium status change by request.
+ */
 public interface FastLoginPremiumToggleEvent {
 
     StoredProfile getProfile();