Added some docs

discord-jda · Oct 27, 2017 · 5580542 · 5580542
1 parent 017dae7
commit 5580542
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/src/main/java/net/dv8tion/jda/core/events/self/SelfUpdateMobileEvent.java b/src/main/java/net/dv8tion/jda/core/events/self/SelfUpdateMobileEvent.java
@@ -18,6 +18,10 @@
 
 import net.dv8tion.jda.core.JDA;
 
+/**
+ * <b><u>SelfUpdateMobileEvent</u></b><br>
+ * Fired if you login to your discord account with a mobile device for the first time.<br>
+ */
 public class SelfUpdateMobileEvent extends GenericSelfUpdateEvent
 {
     private final boolean wasMobile;
@@ -28,6 +32,11 @@ public SelfUpdateMobileEvent(JDA api, long responseNumber, boolean wasMobile)
         this.wasMobile = wasMobile;
     }
 
+    /**
+     * Returns the old mobile status. <i>Should</i> always be {@code false}.
+     *
+     * @return The mobile status.
+     */
     public boolean wasMobile()
     {
         return wasMobile;

diff --git a/src/main/java/net/dv8tion/jda/core/events/self/SelfUpdateNitroEvent.java b/src/main/java/net/dv8tion/jda/core/events/self/SelfUpdateNitroEvent.java
@@ -18,6 +18,10 @@
 
 import net.dv8tion.jda.core.JDA;
 
+/**
+ * <b><u>SelfUpdateNitroEvent</u></b><br>
+ * Fired if you subscribe to nitro or your active nitro subscription runs out.<br>
+ */
 public class SelfUpdateNitroEvent extends GenericSelfUpdateEvent
 {
     private final boolean wasNitro;
@@ -28,6 +32,11 @@ public SelfUpdateNitroEvent(JDA api, long responseNumber, boolean wasNitro)
         this.wasNitro = wasNitro;
     }
 
+    /**
+     * Returns whether or not a nitro subscription used to be active before.
+     *
+     * @return The the old nitro subscription status.
+     */
     public boolean wasNitro()
     {
         return wasNitro;

diff --git a/src/main/java/net/dv8tion/jda/core/events/self/SelfUpdatePhoneNumberEvent.java b/src/main/java/net/dv8tion/jda/core/events/self/SelfUpdatePhoneNumberEvent.java
@@ -18,6 +18,10 @@
 
 import net.dv8tion.jda.core.JDA;
 
+/**
+ * <b><u>SelfUpdatePhoneNumberEvent</u></b><br>
+ * Fired if you change the phone number associated with your account.<br>
+ */
 public class SelfUpdatePhoneNumberEvent extends GenericSelfUpdateEvent
 {
     private final String oldPhoneNumber;
@@ -28,6 +32,11 @@ public SelfUpdatePhoneNumberEvent(JDA api, long responseNumber, String oldPhoneN
         this.oldPhoneNumber = oldPhoneNumber;
     }
 
+    /**
+     * Returns the old phone number or {@code null} if no phone number was previously set.
+     *
+     * @return The old phone number or {@code null}.
+     */
     public String getOldPhoneNumber()
     {
         return oldPhoneNumber;