From 3d0e5716e72b5ce6be36ffc93668ccdca138634e Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Sat, 31 Aug 2019 19:36:17 +0200 Subject: [PATCH] Add documentation --- .../smackx/sid/StableUniqueStanzaIdManager.java | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/sid/StableUniqueStanzaIdManager.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/sid/StableUniqueStanzaIdManager.java index 98b8a26a0..b43cc6078 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/sid/StableUniqueStanzaIdManager.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/sid/StableUniqueStanzaIdManager.java @@ -36,6 +36,15 @@ import org.jivesoftware.smack.packet.Stanza; import org.jivesoftware.smackx.disco.ServiceDiscoveryManager; import org.jivesoftware.smackx.sid.element.OriginIdElement; +/** + * Manager class for Stable and Unique Stanza IDs. + * + * In order to start automatically appending origin ids to outgoing messages, use {@link #enable()}. + * This will announce support via the {@link ServiceDiscoveryManager}. If you want to stop appending origin-ids + * and de-announce support, call {@link #disable()}. + * + * @see XEP-0359: Stable and Unique Stanza IDs + */ public final class StableUniqueStanzaIdManager extends Manager { public static final String NAMESPACE = "urn:xmpp:sid:0"; @@ -70,7 +79,7 @@ public final class StableUniqueStanzaIdManager extends Manager { /** * Private constructor. - * @param connection TODO javadoc me please + * @param connection XMPP connection */ private StableUniqueStanzaIdManager(XMPPConnection connection) { super(connection);