Add javadoc for XMPPConnection.send(PlainStreamElement)

Flowdalic · Oct 13, 2014 · 0ef50bf · 0ef50bf
1 parent c674808
commit 0ef50bf
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnection.java b/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnection.java
@@ -154,11 +154,17 @@ public interface XMPPConnection {
     public void sendPacket(Packet packet) throws NotConnectedException;
 
     /**
-     * 
+     * Send a PlainStreamElement.
+     * <p>
+     * <b>This method is not meant for end-user usage!</b> It allows sending plain stream elements, which should not be
+     * done by a user manually. <b>Doing so may result in a unstable or unusable connection.</b> Certain Smack APIs use
+     * this method to send plain stream elements.
+     * </p>
+     *
      * @param element
      * @throws NotConnectedException
      */
-    public void  send(PlainStreamElement element) throws NotConnectedException;
+    public void send(PlainStreamElement element) throws NotConnectedException;
 
     /**
      * Returns the roster for the user.