From af8822791914d9f00bb9acdffe9bb60962e1bf5d Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Sat, 6 Apr 2019 02:36:32 +0200
Subject: [PATCH] Add missing Roster documentation

---
 .../org/jivesoftware/smack/roster/Roster.java   | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/smack-im/src/main/java/org/jivesoftware/smack/roster/Roster.java b/smack-im/src/main/java/org/jivesoftware/smack/roster/Roster.java
index 8e241151d..08889fe51 100644
--- a/smack-im/src/main/java/org/jivesoftware/smack/roster/Roster.java
+++ b/smack-im/src/main/java/org/jivesoftware/smack/roster/Roster.java
@@ -560,7 +560,8 @@ public final class Roster extends Manager {
     }
 
     /**
-     * Add a roster loaded listener.
+     * Add a roster loaded listener. Roster loaded listeners are invoked once the {@link Roster}
+     * was successfully loaded.
      *
      * @param rosterLoadedListener the listener to add.
      * @return true if the listener was not already added.
@@ -587,6 +588,20 @@ public final class Roster extends Manager {
         }
     }
 
+    /**
+     * Add a {@link PresenceEventListener}. Such a listener will be fired whenever certain
+     * presence events happen.<p>
+     * Among those events are:
+     * <ul>
+     * <li> 'available' presence received
+     * <li> 'unavailable' presence received
+     * <li> 'error' presence received
+     * <li> 'subscribed' presence received
+     * <li> 'unsubscribed' presence received
+     * </ul>
+     * @param presenceEventListener listener to add.
+     * @return true if the listener was not already added.
+     */
     public boolean addPresenceEventListener(PresenceEventListener presenceEventListener) {
         return presenceEventListeners.add(presenceEventListener);
     }