From 6daf19dbd3b838f168cf549591ddefd3b1b59eb6 Mon Sep 17 00:00:00 2001
From: Florian Schmaus <flo@geekplace.eu>
Date: Sat, 16 May 2020 14:16:05 +0200
Subject: [PATCH] [core] Add javadoc to SmackReactor.cancel(ScheduledAction)

---
 .../src/main/java/org/jivesoftware/smack/SmackReactor.java  | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/smack-core/src/main/java/org/jivesoftware/smack/SmackReactor.java b/smack-core/src/main/java/org/jivesoftware/smack/SmackReactor.java
index 76d028204..6d870a9ca 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/SmackReactor.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/SmackReactor.java
@@ -154,6 +154,12 @@ public class SmackReactor {
         return scheduledAction;
     }
 
+    /**
+     * Cancels the scheduled action.
+     *
+     * @param scheduledAction the scheduled action to cancel.
+     * @return <code>true</code> if the scheduled action was still pending and got removed, <code>false</code> otherwise.
+     */
     boolean cancel(ScheduledAction scheduledAction) {
         return scheduledActions.remove(scheduledAction);
     }