connect() with login().
* @throws InterruptedException
*/
@@ -1554,7 +1552,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection {
/**
* Install a parsing exception callback, which will be invoked once an exception is encountered while parsing a
- * stanza
+ * stanza.
*
* @param callback the callback to install
*/
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/ConnectionConfiguration.java b/smack-core/src/main/java/org/jivesoftware/smack/ConnectionConfiguration.java
index e40d7c3f1..3131dc46e 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/ConnectionConfiguration.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/ConnectionConfiguration.java
@@ -497,7 +497,7 @@ public abstract class ConnectionConfiguration {
/**
* Sets the PKCS11 library file location, needed when the
- * Keystore type is PKCS11
+ * Keystore type is PKCS11.
*
* @param pkcs11Library the path to the PKCS11 library file.
* @return a reference to this builder.
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/MessageListener.java b/smack-core/src/main/java/org/jivesoftware/smack/MessageListener.java
index 3c66ddf53..340f0eee0 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/MessageListener.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/MessageListener.java
@@ -19,9 +19,6 @@ package org.jivesoftware.smack;
import org.jivesoftware.smack.packet.Message;
-/**
- *
- */
public interface MessageListener {
void processMessage(Message message);
}
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/PacketListener.java b/smack-core/src/main/java/org/jivesoftware/smack/PacketListener.java
index 856a53c54..a1298d24f 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/PacketListener.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/PacketListener.java
@@ -18,6 +18,7 @@
package org.jivesoftware.smack;
/**
+ * This interface is deprecated.
* @deprecated use {@link StanzaListener} instead
*/
@Deprecated
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/PresenceListener.java b/smack-core/src/main/java/org/jivesoftware/smack/PresenceListener.java
index a2156d981..02cc6af4e 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/PresenceListener.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/PresenceListener.java
@@ -19,9 +19,6 @@ package org.jivesoftware.smack;
import org.jivesoftware.smack.packet.Presence;
-/**
- *
- */
public interface PresenceListener {
void processPresence(Presence presence);
}
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/ReconnectionManager.java b/smack-core/src/main/java/org/jivesoftware/smack/ReconnectionManager.java
index da478fd5a..2986fec72 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/ReconnectionManager.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/ReconnectionManager.java
@@ -121,7 +121,7 @@ public class ReconnectionManager {
}
/**
- * Set the default Reconnection Policy to use
+ * Set the default Reconnection Policy to use.
*
* @param reconnectionPolicy
*/
@@ -131,7 +131,7 @@ public class ReconnectionManager {
/**
* Set the fixed delay in seconds between the reconnection attempts Also set the connection
- * policy to {@link ReconnectionPolicy#FIXED_DELAY}
+ * policy to {@link ReconnectionPolicy#FIXED_DELAY}.
*
* @param fixedDelay Delay expressed in seconds
*/
@@ -141,7 +141,7 @@ public class ReconnectionManager {
}
/**
- * Set the Reconnection Policy to use
+ * Set the Reconnection Policy to use.
*
* @param reconnectionPolicy
*/
@@ -150,7 +150,7 @@ public class ReconnectionManager {
}
/**
- * Flag that indicates if a reconnection should be attempted when abruptly disconnected
+ * Flag that indicates if a reconnection should be attempted when abruptly disconnected.
*/
private boolean automaticReconnectEnabled = false;
@@ -357,17 +357,17 @@ public class ReconnectionManager {
/**
* Reconnection Policy, where {@link ReconnectionPolicy#RANDOM_INCREASING_DELAY} is the default policy used by smack and {@link ReconnectionPolicy#FIXED_DELAY} implies
- * a fixed amount of time between reconnection attempts
+ * a fixed amount of time between reconnection attempts.
*/
public enum ReconnectionPolicy {
/**
* Default policy classically used by smack, having an increasing delay related to the
- * overall number of attempts
+ * overall number of attempts.
*/
RANDOM_INCREASING_DELAY,
/**
- * Policy using fixed amount of time between reconnection attempts
+ * Policy using fixed amount of time between reconnection attempts.
*/
FIXED_DELAY,
;
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/SASLAuthentication.java b/smack-core/src/main/java/org/jivesoftware/smack/SASLAuthentication.java
index 4da349e8e..fff9b8fe2 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/SASLAuthentication.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/SASLAuthentication.java
@@ -65,7 +65,7 @@ public class SASLAuthentication {
private static final Setnull
*/
public static SmackDebuggerFactory getDebuggerFactory() {
@@ -230,7 +232,7 @@ public final class SmackConfiguration {
}
/**
- * Set the default parsing exception callback for all newly created connections
+ * Set the default parsing exception callback for all newly created connections.
*
* @param callback
* @see ParsingExceptionCallback
@@ -240,7 +242,7 @@ public final class SmackConfiguration {
}
/**
- * Returns the default parsing exception callback
+ * Returns the default parsing exception callback.
*
* @return the default parsing exception callback
* @see ParsingExceptionCallback
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/debugger/ReflectionDebuggerFactory.java b/smack-core/src/main/java/org/jivesoftware/smack/debugger/ReflectionDebuggerFactory.java
index 08e9f76a9..ecd78ceeb 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/debugger/ReflectionDebuggerFactory.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/debugger/ReflectionDebuggerFactory.java
@@ -44,7 +44,7 @@ public class ReflectionDebuggerFactory implements SmackDebuggerFactory {
};
/**
- * Sets custom debugger class to be created by this factory
+ * Sets custom debugger class to be created by this factory.
* @param debuggerClass class to be used by this factory
*/
public static void setDebuggerClass(Class debuggerClass) {
@@ -56,7 +56,7 @@ public class ReflectionDebuggerFactory implements SmackDebuggerFactory {
}
/**
- * Returns debugger class used by this factory
+ * Returns debugger class used by this factory.
* @return debugger class that will be used for instantiation by this factory
*/
@SuppressWarnings("unchecked")
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/AbstractListFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/AbstractListFilter.java
index f4f7ceae3..0b5f47ba8 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/filter/AbstractListFilter.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/AbstractListFilter.java
@@ -24,9 +24,6 @@ import java.util.List;
import org.jivesoftware.smack.util.Objects;
-/**
- *
- */
public abstract class AbstractListFilter implements StanzaFilter {
/**
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/IQResultReplyFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/IQResultReplyFilter.java
index a8225dcf4..64bb24ee6 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/filter/IQResultReplyFilter.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/IQResultReplyFilter.java
@@ -20,9 +20,6 @@ import org.jivesoftware.smack.XMPPConnection;
import org.jivesoftware.smack.packet.IQ;
import org.jivesoftware.smack.packet.Stanza;
-/**
- *
- */
public class IQResultReplyFilter extends IQReplyFilter {
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/MessageWithBodiesFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/MessageWithBodiesFilter.java
index 47ab3ab52..258c8c9c3 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/filter/MessageWithBodiesFilter.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/MessageWithBodiesFilter.java
@@ -20,7 +20,7 @@ package org.jivesoftware.smack.filter;
import org.jivesoftware.smack.packet.Message;
/**
- * Filters message stanzas which have at least one body
+ * Filters message stanzas which have at least one body.
*/
public class MessageWithBodiesFilter extends FlexibleStanzaTypeFilternull
@@ -151,7 +151,7 @@ public class SaslStreamElements {
}
/**
- * A SASL failure stream element, also called "SASL Error"
+ * A SASL failure stream element, also called "SASL Error".
* @see RFC 6120 6.5 SASL Errors
*/
public static class SASLFailure extends AbstractError implements PlainStreamElement {
@@ -188,6 +188,7 @@ public class SaslStreamElements {
}
/**
+ * Get the SASL error as String.
* @return the SASL error as String
*/
public String getSASLErrorString() {
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/FileUtils.java b/smack-core/src/main/java/org/jivesoftware/smack/util/FileUtils.java
index db68c69b1..efe7d05f9 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/util/FileUtils.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/util/FileUtils.java
@@ -96,7 +96,7 @@ public final class FileUtils {
}
/**
- * Reads the contents of a File
+ * Reads the contents of a File.
*
* @param file
* @return the content of file or null in case of an error
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/PacketParserUtils.java b/smack-core/src/main/java/org/jivesoftware/smack/util/PacketParserUtils.java
index f4c7d1a0f..fb2fa7118 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/util/PacketParserUtils.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/util/PacketParserUtils.java
@@ -28,7 +28,6 @@ import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
-import org.jivesoftware.smack.SmackException;
import org.jivesoftware.smack.compress.packet.Compress;
import org.jivesoftware.smack.packet.DefaultExtensionElement;
import org.jivesoftware.smack.packet.EmptyResultIQ;
@@ -593,9 +592,7 @@ public class PacketParserUtils {
*
* @param parser the XML parser, positioned at the start of an IQ packet.
* @return an IQ object.
- * @throws XmlPullParserException
- * @throws IOException
- * @throws SmackException
+ * @throws Exception
*/
public static IQ parseIQ(XmlPullParser parser) throws Exception {
ParserUtils.assertAtStartTag(parser);
@@ -887,6 +884,7 @@ public class PacketParserUtils {
}
/**
+ * Parse an extension element.
* @deprecated use {@link #parseExtensionElement(String, String, XmlPullParser)} instead.
*/
@Deprecated
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/PacketUtil.java b/smack-core/src/main/java/org/jivesoftware/smack/util/PacketUtil.java
index 97673f74c..a94369792 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/util/PacketUtil.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/util/PacketUtil.java
@@ -23,7 +23,7 @@ import org.jivesoftware.smack.packet.ExtensionElement;
public class PacketUtil {
/**
- * Get a extension element from a collection
+ * Get a extension element from a collection.
*
* @param collection
* @param element
@@ -39,7 +39,7 @@ public class PacketUtil {
}
/**
- * Get a extension element from a collection
+ * Get a extension element from a collection.
*
* @param collection
* @param element
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/StringUtils.java b/smack-core/src/main/java/org/jivesoftware/smack/util/StringUtils.java
index 2e970ca64..d8318adee 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/util/StringUtils.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/util/StringUtils.java
@@ -187,7 +187,7 @@ public class StringUtils {
}
/**
- * Returns true if CharSequence is not null and is not empty, false otherwise
+ * Returns true if CharSequence is not null and is not empty, false otherwise.
* Examples:
* isNotEmpty(null) - false
* isNotEmpty("") - false
@@ -212,7 +212,7 @@ public class StringUtils {
}
/**
- * Returns true if the given CharSequence is empty
+ * Returns true if the given CharSequence is empty.
*
* @param cs
* @return true if the given CharSequence is empty
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/XmlStringBuilder.java b/smack-core/src/main/java/org/jivesoftware/smack/util/XmlStringBuilder.java
index db0e1304e..2787a37e6 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/util/XmlStringBuilder.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/util/XmlStringBuilder.java
@@ -50,6 +50,7 @@ public class XmlStringBuilder implements Appendable, CharSequence {
}
/**
+ * Add a new element to this builder.
*
* @param name
* @param content
@@ -64,6 +65,7 @@ public class XmlStringBuilder implements Appendable, CharSequence {
}
/**
+ * Add a new element to this builder.
*
* @param name
* @param content
@@ -158,7 +160,7 @@ public class XmlStringBuilder implements Appendable, CharSequence {
}
/**
- * Add a right angle bracket '>'
+ * Add a right angle bracket '>'.
*
* @return a reference to this object.
*/
@@ -168,7 +170,7 @@ public class XmlStringBuilder implements Appendable, CharSequence {
}
/**
- *
+ * Add a right angle bracket '>'.
* @return a reference to this object
* @deprecated use {@link #rightAngleBracket()} instead
*/
@@ -229,7 +231,7 @@ public class XmlStringBuilder implements Appendable, CharSequence {
}
/**
- * Add the given attribute if value => 0
+ * Add the given attribute if {@code value => 0}.
*
* @param name
* @param value
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/dns/SRVRecord.java b/smack-core/src/main/java/org/jivesoftware/smack/util/dns/SRVRecord.java
index 2d2707d26..7da214c55 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/util/dns/SRVRecord.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/util/dns/SRVRecord.java
@@ -17,6 +17,8 @@
package org.jivesoftware.smack.util.dns;
/**
+ * A DNS SRV RR.
+ *
* @see RFC 2782: A DNS RR for specifying the location of services (DNS
* SRV)
* @author Florian Schmaus
@@ -28,7 +30,7 @@ public class SRVRecord extends HostAddress implements Comparable
* Delayed Delivery (XEP-203)
@@ -75,7 +75,7 @@ public class DelayInformationManager {
}
/**
- * Get the Delayed Delivery timestamp or null
+ * Get the Delayed Delivery timestamp or null.
*
* @param packet
* @return the Delayed Delivery timestamp or null
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java
index 8957a103b..00450d7ea 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java
@@ -108,7 +108,8 @@ public class DelayInformation implements ExtensionElement {
}
/**
- *
+ * Return delay information from the given stanza.
+ *
* @param packet
* @return the DelayInformation or null
* @deprecated use {@link #from(Stanza)} instead
@@ -119,7 +120,8 @@ public class DelayInformation implements ExtensionElement {
}
/**
- *
+ * Return delay information from the given stanza.
+ *
* @param packet
* @return the DelayInformation or null
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/AbstractNodeInformationProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/AbstractNodeInformationProvider.java
index 426b59fde..ba9ecddaa 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/AbstractNodeInformationProvider.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/AbstractNodeInformationProvider.java
@@ -23,9 +23,6 @@ import org.jivesoftware.smackx.disco.packet.DiscoverItems;
import java.util.List;
-/**
- *
- */
public abstract class AbstractNodeInformationProvider implements NodeInformationProvider {
public List getNodeItems() {
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java
index ad16998bd..1ea1c2276 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java
@@ -260,7 +260,7 @@ public class ServiceDiscoveryManager extends Manager {
}
/**
- * Returns all identities of this client as unmodifiable Collection
+ * Returns all identities of this client as unmodifiable Collection.
*
* @return all identies as set
*/
@@ -432,7 +432,7 @@ public class ServiceDiscoveryManager extends Manager {
}
/**
- * Returns the data form that is set as extended information for this Service Discovery instance (XEP-0128)
+ * Returns the data form that is set as extended information for this Service Discovery instance (XEP-0128).
*
* @see XEP-128: Service Discovery Extensions
* @return the data form
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfo.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfo.java
index afaacb5c5..360df83ff 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfo.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfo.java
@@ -56,7 +56,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable {
}
/**
- * Copy constructor
+ * Copy constructor.
*
* @param d
*/
@@ -128,7 +128,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable {
}
/**
- * Adds identities to the DiscoverInfo stanza
+ * Adds identities to the DiscoverInfo stanza.
*
* @param identitiesToAdd
*/
@@ -354,7 +354,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable {
}
/**
- * Returns the identities natural language if one is set
+ * Returns the identities natural language if one is set.
*
* @return the value of xml:lang of this Identity
*/
@@ -391,7 +391,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable {
/**
* Check equality for Identity for category, type, lang and name
* in that order as defined by
- * XEP-0015 5.4 Processing Method (Step 3.3)
+ * XEP-0015 5.4 Processing Method (Step 3.3).
*
*/
public boolean equals(Object obj) {
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransfer.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransfer.java
index 74d4737e1..ae99f6224 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransfer.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransfer.java
@@ -288,7 +288,7 @@ public abstract class FileTransfer {
complete("Complete"),
/**
- * The file transfer was cancelled
+ * The file transfer was cancelled.
*/
cancelled("Cancelled");
@@ -313,7 +313,7 @@ public abstract class FileTransfer {
public enum Error {
/**
- * No error
+ * No error.
*/
none("No error"),
@@ -339,7 +339,7 @@ public abstract class FileTransfer {
connection("An error occured over the socket connected to send the file."),
/**
- * An error occurred while sending or receiving the file
+ * An error occurred while sending or receiving the file.
*/
stream("An error occured while sending or recieving the file.");
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/OutgoingFileTransfer.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/OutgoingFileTransfer.java
index b00542526..c8eaf8cf9 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/OutgoingFileTransfer.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/OutgoingFileTransfer.java
@@ -438,7 +438,7 @@ public class OutgoingFileTransfer extends FileTransfer {
public interface NegotiationProgress {
/**
- * Called when the status changes
+ * Called when the status changes.
*
* @param oldStatus the previous status of the file transfer.
* @param newStatus the new status of the file transfer.
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/forward/packet/Forwarded.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/forward/packet/Forwarded.java
index f9484e07f..698455f6f 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/forward/packet/Forwarded.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/forward/packet/Forwarded.java
@@ -93,7 +93,7 @@ public class Forwarded implements ExtensionElement {
}
/**
- *
+ * Get the forwarded extension.
* @param packet
* @return the Forwarded extension or null
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqlast/LastActivityManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqlast/LastActivityManager.java
index c974dbcf3..3fbed38f2 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqlast/LastActivityManager.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqlast/LastActivityManager.java
@@ -242,7 +242,7 @@ public class LastActivityManager extends Manager {
}
/**
- * Returns true if Last Activity (XEP-0012) is supported by a given JID
+ * Returns true if Last Activity (XEP-0012) is supported by a given JID.
*
* @param jid a JID to be tested for Last Activity support
* @return true if Last Activity is supported, otherwise false
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqversion/packet/Version.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqversion/packet/Version.java
index 1debbb29a..c257a758a 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqversion/packet/Version.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqversion/packet/Version.java
@@ -45,7 +45,7 @@ public class Version extends IQ {
}
/**
- * Request version IQ
+ * Request version IQ.
*
* @param to the jid where to request version from
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MUCAffiliation.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MUCAffiliation.java
index 77fa3f647..0fdb14935 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MUCAffiliation.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MUCAffiliation.java
@@ -19,7 +19,7 @@ package org.jivesoftware.smackx.muc;
import java.util.Locale;
/**
- * XEP-0045: Multi-User-Chat - 5.2 Affiliations
+ * XEP-0045: Multi-User-Chat - 5.2 Affiliations.
*
* @see XEP-0045: Multi-User-Chat - 5.2 Affiliations
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MUCRole.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MUCRole.java
index 1f23bc360..82a85ff6d 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MUCRole.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MUCRole.java
@@ -19,7 +19,7 @@ package org.jivesoftware.smackx.muc;
import java.util.Locale;
/**
- * XEP-0045: Multi User Chat - 5.1 Roles
+ * XEP-0045: Multi User Chat - 5.1 Roles.
*
* @see XEP-0045: Multi-User-Chat - 5.1 Roles
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java
index 084b223fa..dfd327296 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java
@@ -109,7 +109,7 @@ public class GroupChatInvitation implements ExtensionElement {
}
/**
- *
+ * Deprecated.
* @param packet
* @return the GroupChatInvitation or null
* @deprecated use {@link #from(Stanza)} instead
@@ -120,7 +120,7 @@ public class GroupChatInvitation implements ExtensionElement {
}
/**
- *
+ * Get the group chat invitation from the given stanza.
* @param packet
* @return the GroupChatInvitation or null
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/nick/packet/Nick.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/nick/packet/Nick.java
index b5bbb22f6..d8e21f26b 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/nick/packet/Nick.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/nick/packet/Nick.java
@@ -42,7 +42,7 @@ public class Nick implements ExtensionElement {
}
/**
- * The value of this nickname
+ * The value of this nickname.
*
* @return the nickname
*/
@@ -51,7 +51,7 @@ public class Nick implements ExtensionElement {
}
/**
- * Sets the value of this nickname
+ * Sets the value of this nickname.
*
* @param name
* the name to set
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/provider/PEPProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/provider/PEPProvider.java
index 301bfafaa..3702b4a0c 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/provider/PEPProvider.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pep/provider/PEPProvider.java
@@ -17,15 +17,12 @@
package org.jivesoftware.smackx.pep.provider;
-import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
-import org.jivesoftware.smack.SmackException;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.provider.ExtensionElementProvider;
import org.xmlpull.v1.XmlPullParser;
-import org.xmlpull.v1.XmlPullParserException;
/**
*
@@ -55,9 +52,7 @@ public class PEPProvider extends ExtensionElementProvider {
*
* @param parser the XML parser, positioned at the starting element of the extension.
* @return a PacketExtension.
- * @throws IOException
- * @throws XmlPullParserException
- * @throws SmackException
+ * @throws Exception
*/
@Override
public ExtensionElement parse(XmlPullParser parser, int initialDepth)
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/PingManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/PingManager.java
index 8b3ab5bdb..d27da55eb 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/PingManager.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/PingManager.java
@@ -190,7 +190,7 @@ public class PingManager extends Manager {
}
/**
- * Query the specified entity to see if it supports the Ping protocol (XEP-0199)
+ * Query the specified entity to see if it supports the Ping protocol (XEP-0199).
*
* @param jid The id of the entity the query is being sent to
* @return true if it supports ping, false otherwise.
@@ -288,7 +288,7 @@ public class PingManager extends Manager {
}
/**
- * Register a new PingFailedListener
+ * Register a new PingFailedListener.
*
* @param listener the listener to invoke
*/
@@ -297,7 +297,7 @@ public class PingManager extends Manager {
}
/**
- * Unregister a PingFailedListener
+ * Unregister a PingFailedListener.
*
* @param listener the listener to remove
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/packet/Ping.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/packet/Ping.java
index 7025bbc85..8727ad704 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/packet/Ping.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/packet/Ping.java
@@ -36,7 +36,7 @@ public class Ping extends SimpleIQ {
}
/**
- * Create an XMPP Pong for this Ping
+ * Create an XMPP Pong for this Ping.
*
* @return the Pong
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/AccessModel.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/AccessModel.java
index 0d22603a2..6748cd40a 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/AccessModel.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/AccessModel.java
@@ -18,24 +18,24 @@ package org.jivesoftware.smackx.pubsub;
/**
* This enumeration represents the access models for the pubsub node
- * as defined in the pubsub specification section 16.4.3
+ * as defined in the pubsub specification section 16.4.3.
*
* @author Robin Collier
*/
public enum AccessModel
{
- /** Anyone may subscribe and retrieve items */
+ /** Anyone may subscribe and retrieve items. */
open,
- /** Subscription request must be approved and only subscribers may retrieve items */
+ /** Subscription request must be approved and only subscribers may retrieve items. */
authorize,
- /** Anyone with a presence subscription of both or from may subscribe and retrieve items */
+ /** Anyone with a presence subscription of both or from may subscribe and retrieve items. */
presence,
- /** Anyone in the specified roster group(s) may subscribe and retrieve items */
+ /** Anyone in the specified roster group(s) may subscribe and retrieve items. */
roster,
- /** Only those on a whitelist may subscribe and retrieve items */
+ /** Only those on a whitelist may subscribe and retrieve items. */
whitelist;
}
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ChildrenAssociationPolicy.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ChildrenAssociationPolicy.java
index e823db836..cab4ddb64 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ChildrenAssociationPolicy.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ChildrenAssociationPolicy.java
@@ -18,13 +18,13 @@ package org.jivesoftware.smackx.pubsub;
/**
* This enumeration represents the children association policy for associating leaf nodes
- * with collection nodes as defined in the pubsub specification section 16.4.3
+ * with collection nodes as defined in the pubsub specification section 16.4.3.
*
* @author Robin Collier
*/
public enum ChildrenAssociationPolicy
{
- /** Anyone may associate leaf nodes with the collection */
+ /** Anyone may associate leaf nodes with the collection. */
all,
/** Only collection node owners may associate leaf nodes with the collection. */
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureForm.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureForm.java
index 8ff33db47..144c50393 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureForm.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureForm.java
@@ -282,7 +282,7 @@ public class ConfigureForm extends Form
}
/**
- * Determines who should get replies to items
+ * Determines who should get replies to items.
*
* @return Who should get the reply
*/
@@ -297,7 +297,7 @@ public class ConfigureForm extends Form
}
/**
- * Sets who should get the replies to items
+ * Sets who should get the replies to items.
*
* @param reply Defines who should get the reply
*/
@@ -341,7 +341,7 @@ public class ConfigureForm extends Form
}
/**
- * Sets the maximum payload size in bytes
+ * Sets the maximum payload size in bytes.
*
* @param max The maximum payload size
*/
@@ -352,7 +352,7 @@ public class ConfigureForm extends Form
}
/**
- * Gets the node type
+ * Gets the node type.
*
* @return The node type
*/
@@ -367,7 +367,7 @@ public class ConfigureForm extends Form
}
/**
- * Sets the node type
+ * Sets the node type.
*
* @param type The node type
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureNodeFields.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureNodeFields.java
index 81d643832..7a3797a6a 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureNodeFields.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureNodeFields.java
@@ -30,7 +30,7 @@ import org.jivesoftware.smackx.xdata.Form;
public enum ConfigureNodeFields
{
/**
- * Determines who may subscribe and retrieve items
+ * Determines who may subscribe and retrieve items.
*
* Value: {@link AccessModel}
*/
@@ -39,14 +39,14 @@ public enum ConfigureNodeFields
/**
* The URL of an XSL transformation which can be applied to
* payloads in order to generate an appropriate message
- * body element
+ * body element.
*
* Value: {@link URL}
*/
body_xslt,
/**
- * The collection with which a node is affiliated
+ * The collection with which a node is affiliated.
*
* Value: String
*/
@@ -63,21 +63,21 @@ public enum ConfigureNodeFields
dataform_xslt,
/**
- * Whether to deliver payloads with event notifications
+ * Whether to deliver payloads with event notifications.
*
* Value: boolean
*/
deliver_payloads,
/**
- * Whether owners or publisher should receive replies to items
+ * Whether owners or publisher should receive replies to items.
*
* Value: {@link ItemReply}
*/
itemreply,
/**
- * Who may associate leaf nodes with a collection
+ * Who may associate leaf nodes with a collection.
*
* Value: {@link ChildrenAssociationPolicy}
*/
@@ -85,14 +85,14 @@ public enum ConfigureNodeFields
/**
* The list of JIDs that may associate leaf nodes with a
- * collection
+ * collection.
*
* Value: List of JIDs as Strings
*/
children_association_whitelist,
/**
- * The child nodes (leaf or collection) associated with a collection
+ * The child nodes (leaf or collection) associated with a collection.
*
* Value: List of Strings
*/
@@ -100,56 +100,56 @@ public enum ConfigureNodeFields
/**
* The maximum number of child nodes that can be associated with a
- * collection
+ * collection.
*
* Value: int
*/
children_max,
/**
- * The maximum number of items to persist
+ * The maximum number of items to persist.
*
* Value: int
*/
max_items,
/**
- * The maximum payload size in bytes
+ * The maximum payload size in bytes.
*
* Value: int
*/
max_payload_size,
/**
- * Whether the node is a leaf (default) or collection
+ * Whether the node is a leaf (default) or collection.
*
* Value: {@link NodeType}
*/
node_type,
/**
- * Whether to notify subscribers when the node configuration changes
+ * Whether to notify subscribers when the node configuration changes.
*
* Value: boolean
*/
notify_config,
/**
- * Whether to notify subscribers when the node is deleted
+ * Whether to notify subscribers when the node is deleted.
*
* Value: boolean
*/
notify_delete,
/**
- * Whether to notify subscribers when items are removed from the node
+ * Whether to notify subscribers when items are removed from the node.
*
* Value: boolean
*/
notify_retract,
/**
- * Whether to persist items to storage. This is required to have multiple
+ * Whether to persist items to storage. This is required to have. multiple
* items in the node.
*
* Value: boolean
@@ -157,49 +157,49 @@ public enum ConfigureNodeFields
persist_items,
/**
- * Whether to deliver notifications to available users only
+ * Whether to deliver notifications to available users only.
*
* Value: boolean
*/
presence_based_delivery,
/**
- * Defines who can publish to the node
+ * Defines who can publish to the node.
*
* Value: {@link PublishModel}
*/
publish_model,
/**
- * The specific multi-user chat rooms to specify for replyroom
+ * The specific multi-user chat rooms to specify for replyroom.
*
* Value: List of JIDs as Strings
*/
replyroom,
/**
- * The specific JID(s) to specify for replyto
+ * The specific JID(s) to specify for replyto.
*
* Value: List of JIDs as Strings
*/
replyto,
/**
- * The roster group(s) allowed to subscribe and retrieve items
+ * The roster group(s) allowed to subscribe and retrieve items.
*
* Value: List of strings
*/
roster_groups_allowed,
/**
- * Whether to allow subscriptions
+ * Whether to allow subscriptions.
*
* Value: boolean
*/
subscribe,
/**
- * A friendly name for the node
+ * A friendly name for the node.
*
* Value: String
*/
@@ -208,7 +208,7 @@ public enum ConfigureNodeFields
/**
* The type of node data, ussually specified by the namespace
* of the payload(if any);MAY be a list-single rather than a
- * text single
+ * text single.
*
* Value: String
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/EventElementType.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/EventElementType.java
index 9cf25f8c1..e02de606b 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/EventElementType.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/EventElementType.java
@@ -24,21 +24,21 @@ package org.jivesoftware.smackx.pubsub;
*/
public enum EventElementType
{
- /** A node has been associated or dissassociated with a collection node */
+ /** A node has been associated or dissassociated with a collection node. */
collection,
- /** A node has had its configuration changed */
+ /** A node has had its configuration changed. */
configuration,
- /** A node has been deleted */
+ /** A node has been deleted. */
delete,
- /** Items have been published to a node */
+ /** Items have been published to a node. */
items,
- /** All items have been purged from a node */
+ /** All items have been purged from a node. */
purge,
- /** A node has been subscribed to */
+ /** A node has been subscribed to. */
subscription
}
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNodeType.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNodeType.java
index 5afe96fb8..95532f5fb 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNodeType.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNodeType.java
@@ -27,16 +27,16 @@ import org.jivesoftware.smackx.pubsub.packet.PubSubNamespace;
*/
public enum FormNodeType
{
- /** Form for configuring an existing node */
+ /** Form for configuring an existing node. */
CONFIGURE_OWNER,
- /** Form for configuring a node during creation */
+ /** Form for configuring a node during creation. */
CONFIGURE,
- /** Form for configuring subscription options */
+ /** Form for configuring subscription options. */
OPTIONS,
- /** Form which represents the default node configuration options */
+ /** Form which represents the default node configuration options. */
DEFAULT;
public PubSubElementType getNodeElement()
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemReply.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemReply.java
index 8cbd46d2b..6928c6d79 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemReply.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemReply.java
@@ -24,9 +24,9 @@ package org.jivesoftware.smackx.pubsub;
*/
public enum ItemReply
{
- /** The node owner */
+ /** The node owner. */
owner,
- /** The item publisher */
+ /** The item publisher. */
publisher;
}
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemsExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemsExtension.java
index 77c7a2fe9..1c9f02947 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemsExtension.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemsExtension.java
@@ -40,10 +40,10 @@ public class ItemsExtension extends NodeExtension implements EmbeddedPacketExten
public enum ItemsElementType
{
- /** An items element, which has an optional max_items attribute when requesting items */
+ /** An items element, which has an optional max_items attribute when requesting items. */
items(PubSubElementType.ITEMS, "max_items"),
- /** A retract element, which has an optional notify attribute when publishing deletions */
+ /** A retract element, which has an optional notify attribute when publishing deletions. */
retract(PubSubElementType.RETRACT, "notify");
private PubSubElementType elem;
@@ -115,7 +115,7 @@ public class ItemsExtension extends NodeExtension implements EmbeddedPacketExten
}
/**
- * Get the type of element
+ * Get the type of element.
*
* @return The element type
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Node.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Node.java
index c22831620..abbc6db7a 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Node.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Node.java
@@ -80,7 +80,7 @@ abstract public class Node
}
/**
- * Get the NodeId
+ * Get the NodeId.
*
* @return the node id
*/
@@ -107,7 +107,7 @@ abstract public class Node
}
/**
- * Update the configuration with the contents of the new {@link Form}
+ * Update the configuration with the contents of the new {@link Form}.
*
* @param submitForm
* @throws XMPPErrorException
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeExtension.java
index 74f7cb4bb..58d05da35 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeExtension.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeExtension.java
@@ -56,7 +56,7 @@ public class NodeExtension implements ExtensionElement
}
/**
- * Gets the node id
+ * Gets the node id.
*
* @return The node id
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeType.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeType.java
index 1fe20ec10..bd29f1901 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeType.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeType.java
@@ -17,7 +17,7 @@
package org.jivesoftware.smackx.pubsub;
/**
- * Defines the available types of nodes
+ * Defines the available types of nodes.
*
* @author Robin Collier
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubManager.java
index 96ea5ce4f..821b27a52 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubManager.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubManager.java
@@ -268,7 +268,7 @@ final public class PubSubManager
}
/**
- * Delete the specified node
+ * Delete the specified node.
*
* @param nodeId
* @throws XMPPErrorException
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PublishModel.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PublishModel.java
index d96f8dcf2..5e26ac7f9 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PublishModel.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PublishModel.java
@@ -24,12 +24,12 @@ package org.jivesoftware.smackx.pubsub;
*/
public enum PublishModel
{
- /** Only publishers may publish */
+ /** Only publishers may publish. */
publishers,
- /** Only subscribers may publish */
+ /** Only subscribers may publish. */
subscribers,
- /** Anyone may publish */
+ /** Anyone may publish. */
open;
}
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeForm.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeForm.java
index 318d45e4c..00397dc62 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeForm.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeForm.java
@@ -98,7 +98,7 @@ public class SubscribeForm extends Form
}
/**
- * Gets the minimum number of milliseconds between sending notification digests
+ * Gets the minimum number of milliseconds between sending notification digests.
*
* @return The frequency in milliseconds
*/
@@ -108,7 +108,7 @@ public class SubscribeForm extends Form
}
/**
- * Sets the minimum number of milliseconds between sending notification digests
+ * Sets the minimum number of milliseconds between sending notification digests.
*
* @param frequency The frequency in milliseconds
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeOptionFields.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeOptionFields.java
index 43df43753..e1c2f84bd 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeOptionFields.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeOptionFields.java
@@ -27,7 +27,7 @@ import java.util.Calendar;
public enum SubscribeOptionFields
{
/**
- * Whether an entity wants to receive or disable notifications
+ * Whether an entity wants to receive or disable notifications.
*
* Value: boolean
*/
@@ -42,14 +42,14 @@ public enum SubscribeOptionFields
digest,
/**
- * The minimum number of seconds between sending any two notifications digests
+ * The minimum number of seconds between sending any two notifications digests.
*
* Value: int
*/
digest_frequency,
/**
- *
+ * Expire.
* Value: {@link Calendar}
*/
expire,
@@ -70,14 +70,15 @@ public enum SubscribeOptionFields
show_values,
/**
- *
+ * Subscription type.
*
* Value:
*/
subscription_type,
/**
- *
+ * Subscription depth.
+ *
* Value:
*/
subscription_depth;
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Subscription.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Subscription.java
index 203a7cb24..bbd16431f 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Subscription.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Subscription.java
@@ -94,7 +94,7 @@ public class Subscription extends NodeExtension
}
/**
- * Gets the JID the subscription is created for
+ * Gets the JID the subscription is created for.
*
* @return The JID
*/
@@ -104,7 +104,7 @@ public class Subscription extends NodeExtension
}
/**
- * Gets the subscription id
+ * Gets the subscription id.
*
* @return The subscription id
*/
@@ -124,7 +124,7 @@ public class Subscription extends NodeExtension
}
/**
- * This value is only relevant when the {@link #getState()} is {@link State#unconfigured}
+ * This value is only relevant when the {@link #getState()} is {@link State#unconfigured}.
*
* @return true if configuration is required, false otherwise
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscriptionsExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscriptionsExtension.java
index 4c98bfe62..f28884469 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscriptionsExtension.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscriptionsExtension.java
@@ -29,7 +29,7 @@ public class SubscriptionsExtension extends NodeExtension
protected List items = Collections.emptyList();
/**
- * Subscriptions to the root node
+ * Subscriptions to the root node.
*
* @param subList The list of subscriptions
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java
index bf02b4f7f..1c717767c 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java
@@ -90,7 +90,7 @@ public class DeliveryReceiptManager extends Manager {
public enum AutoReceiptMode {
/**
- * Never send deliver receipts
+ * Never send deliver receipts.
*/
disabled,
@@ -183,7 +183,7 @@ public class DeliveryReceiptManager extends Manager {
}
/**
- * Returns true if Delivery Receipts are supported by a given JID
+ * Returns true if Delivery Receipts are supported by a given JID.
*
* @param jid
* @return true if supported
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/search/ReportedData.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/search/ReportedData.java
index 8041a7443..73a12c610 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/search/ReportedData.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/search/ReportedData.java
@@ -99,7 +99,7 @@ public class ReportedData {
}
/**
- * Adds a new Column
+ * Adds a new Column.
* @param column the column to add.
*/
public void addColumn(Column column){
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/search/UserSearchManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/search/UserSearchManager.java
index b9b2bff8d..330d27b94 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/search/UserSearchManager.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/search/UserSearchManager.java
@@ -75,7 +75,7 @@ public class UserSearchManager {
/**
* Submits a search form to the server and returns the resulting information
- * in the form of ReportedData
+ * in the form of ReportedData.
*
* @param searchForm the Form to submit for searching.
* @param searchService the name of the search service to use.
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/packet/Header.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/packet/Header.java
index 3b7613713..f6461488c 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/packet/Header.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/packet/Header.java
@@ -21,7 +21,7 @@ import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.util.XmlStringBuilder;
/**
- * Represents a Header entry as specified by the Stanza Headers and Internet Metadata (SHIM)
+ * Represents a Header entry as specified by the Stanza Headers and Internet Metadata (SHIM).
* @author Robin Collier
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/packet/HeadersExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/packet/HeadersExtension.java
index 14ae89c17..215c0f37e 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/packet/HeadersExtension.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/shim/packet/HeadersExtension.java
@@ -24,7 +24,7 @@ import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.util.XmlStringBuilder;
/**
- * Extension representing a list of headers as specified in Stanza Headers and Internet Metadata (SHIM)
+ * Extension representing a list of headers as specified in Stanza Headers and Internet Metadata (SHIM).
*
* @see Header
*
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/si/packet/StreamInitiation.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/si/packet/StreamInitiation.java
index b96368410..2242a0673 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/si/packet/StreamInitiation.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/si/packet/StreamInitiation.java
@@ -243,7 +243,7 @@ public class StreamInitiation extends IQ {
}
/**
- * Sets the MD5 sum of the file's contents
+ * Sets the MD5 sum of the file's contents.
*
* @param hash The MD5 sum of the file's contents.
*/
@@ -252,7 +252,7 @@ public class StreamInitiation extends IQ {
}
/**
- * Returns the MD5 sum of the file's contents
+ * Returns the MD5 sum of the file's contents.
*
* @return Returns the MD5 sum of the file's contents
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/vcardtemp/packet/VCard.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/vcardtemp/packet/VCard.java
index 068d20dd4..a7cc9cbf3 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/vcardtemp/packet/VCard.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/vcardtemp/packet/VCard.java
@@ -247,7 +247,7 @@ public class VCard extends IQ {
}
/**
- * Get home address field
+ * Get home address field.
*
* @param addrField one of POSTAL, PARCEL, (DOM | INTL), PREF, POBOX, EXTADR, STREET,
* LOCALITY, REGION, PCODE, CTRY
@@ -257,7 +257,7 @@ public class VCard extends IQ {
}
/**
- * Set home address field
+ * Set home address field.
*
* @param addrField one of POSTAL, PARCEL, (DOM | INTL), PREF, POBOX, EXTADR, STREET,
* LOCALITY, REGION, PCODE, CTRY
@@ -267,7 +267,7 @@ public class VCard extends IQ {
}
/**
- * Get work address field
+ * Get work address field.
*
* @param addrField one of POSTAL, PARCEL, (DOM | INTL), PREF, POBOX, EXTADR, STREET,
* LOCALITY, REGION, PCODE, CTRY
@@ -277,7 +277,7 @@ public class VCard extends IQ {
}
/**
- * Set work address field
+ * Set work address field.
*
* @param addrField one of POSTAL, PARCEL, (DOM | INTL), PREF, POBOX, EXTADR, STREET,
* LOCALITY, REGION, PCODE, CTRY
@@ -288,7 +288,7 @@ public class VCard extends IQ {
/**
- * Set home phone number
+ * Set home phone number.
*
* @param phoneType one of VOICE, FAX, PAGER, MSG, CELL, VIDEO, BBS, MODEM, ISDN, PCS, PREF
* @param phoneNum phone number
@@ -298,7 +298,7 @@ public class VCard extends IQ {
}
/**
- * Get home phone number
+ * Get home phone number.
*
* @param phoneType one of VOICE, FAX, PAGER, MSG, CELL, VIDEO, BBS, MODEM, ISDN, PCS, PREF
*/
@@ -307,7 +307,7 @@ public class VCard extends IQ {
}
/**
- * Set work phone number
+ * Set work phone number.
*
* @param phoneType one of VOICE, FAX, PAGER, MSG, CELL, VIDEO, BBS, MODEM, ISDN, PCS, PREF
* @param phoneNum phone number
@@ -317,7 +317,7 @@ public class VCard extends IQ {
}
/**
- * Get work phone number
+ * Get work phone number.
*
* @param phoneType one of VOICE, FAX, PAGER, MSG, CELL, VIDEO, BBS, MODEM, ISDN, PCS, PREF
*/
@@ -343,7 +343,7 @@ public class VCard extends IQ {
}
/**
- * Removes the avatar from the vCard
+ * Removes the avatar from the vCard.
*
* This is done by setting the PHOTO value to the empty string as defined in XEP-0153
*/
@@ -436,7 +436,7 @@ public class VCard extends IQ {
}
/**
- * Returns the MIME Type of the avatar or null if none is set
+ * Returns the MIME Type of the avatar or null if none is set.
*
* @return the MIME Type of the avatar or null
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/FormField.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/FormField.java
index df378978b..f546fa577 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/FormField.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/FormField.java
@@ -37,7 +37,7 @@ public class FormField implements NamedElement {
public static final String ELEMENT = "field";
/**
- * The constant String "FORM_TYPE"
+ * The constant String "FORM_TYPE".
*/
public static final String FORM_TYPE = "FORM_TYPE";
@@ -58,17 +58,17 @@ public class FormField implements NamedElement {
bool,
/**
- * Fixed for putting in text to show sections, or just advertise your web site in the middle of the form
+ * Fixed for putting in text to show sections, or just advertise your web site in the middle of the form.
*/
fixed,
/**
- * Is not given to the user at all, but returned with the questionnaire
+ * Is not given to the user at all, but returned with the questionnaire.
*/
hidden,
/**
- * multiple entries for JIDs
+ * multiple entries for JIDs.
*/
jid_multi,
@@ -244,6 +244,8 @@ public class FormField implements NamedElement {
}
/**
+ * Get validate element.
+ *
* @return the validateElement
*/
public ValidateElement getValidateElement() {
@@ -283,6 +285,7 @@ public class FormField implements NamedElement {
}
/**
+ * Set validate element.
* @param validateElement the validateElement to set
*/
public void setValidateElement(ValidateElement validateElement) {
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/packet/DataForm.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/packet/DataForm.java
index 19776a392..4ccb9d85f 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/packet/DataForm.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/packet/DataForm.java
@@ -301,7 +301,7 @@ public class DataForm implements ExtensionElement {
}
/**
- *
+ * Get data form from stanza.
* @param packet
* @return the DataForm or null
*/
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatalayout/packet/DataLayout.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatalayout/packet/DataLayout.java
index d26732bc4..a499b89e7 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatalayout/packet/DataLayout.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatalayout/packet/DataLayout.java
@@ -40,6 +40,7 @@ public class DataLayout implements ExtensionElement {
private final String label;
/**
+ * Data layout constructor.
* @param label
*/
public DataLayout(String label) {
@@ -116,6 +117,7 @@ public class DataLayout implements ExtensionElement {
private final String var;
/**
+ * Field ref constructor.
* @param var reference to a field
*/
public Fieldref(String var) {
@@ -152,6 +154,7 @@ public class DataLayout implements ExtensionElement {
private final String label;
/**
+ * Section constructor.
* @param label
*/
public Section(String label) {
@@ -226,6 +229,7 @@ public class DataLayout implements ExtensionElement {
private final String text;
/**
+ * Text constructor.
* @param text reference to a field
*/
public Text(String text) {
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/ValidationConsistencyException.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/ValidationConsistencyException.java
index 1b374484d..90398f75f 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/ValidationConsistencyException.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/ValidationConsistencyException.java
@@ -32,6 +32,7 @@ public class ValidationConsistencyException extends IllegalArgumentException {
private static final long serialVersionUID = 1L;
/**
+ * Validation consistency exception constructor.
* @param message
*/
public ValidationConsistencyException(String message) {
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/packet/ValidateElement.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/packet/ValidateElement.java
index 2d0899e10..4aeb61b30 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/packet/ValidateElement.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/packet/ValidateElement.java
@@ -98,6 +98,7 @@ public abstract class ValidateElement implements ExtensionElement {
protected abstract void appendXML(XmlStringBuilder buf);
/**
+ * Set list range.
* @param listRange the listRange to set
*/
public void setListRange(ListRange listRange) {
@@ -105,6 +106,7 @@ public abstract class ValidateElement implements ExtensionElement {
}
/**
+ * Get list range.
* @return the listRange
*/
public ListRange getListRange() {
@@ -112,7 +114,7 @@ public abstract class ValidateElement implements ExtensionElement {
}
/**
- * Check if this element is consistent according to the business rules in XEP=0122
+ * Check if this element is consistent according to the business rules in XEP=0122.
*
* @param formField
*/
@@ -129,6 +131,7 @@ public abstract class ValidateElement implements ExtensionElement {
public static final String METHOD = "basic";
/**
+ * Basic validate element constructor.
* @param dataType
* @see #getDatatype()
*/
@@ -170,6 +173,7 @@ public abstract class ValidateElement implements ExtensionElement {
public static final String METHOD = "open";
/**
+ * Open validate element constructor.
* @param dataType
* @see #getDatatype()
*/
@@ -210,6 +214,7 @@ public abstract class ValidateElement implements ExtensionElement {
private final String max;
/**
+ * Range validate element constructor.
* @param dataType
* @param min the minimum allowable value. This attribute is OPTIONAL. The value depends on the datatype in use.
* @param max the maximum allowable value. This attribute is OPTIONAL. The value depends on the datatype in use.
@@ -273,6 +278,7 @@ public abstract class ValidateElement implements ExtensionElement {
private final String regex;
/**
+ * Regex validate element.
* @param dataType
* @param regex
* @see #getDatatype()
diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManagerTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManagerTest.java
index 188c29be7..637e9e191 100644
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManagerTest.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManagerTest.java
@@ -80,7 +80,7 @@ public class InBandBytestreamManagerTest extends InitExtensions {
/**
* Test that
* {@link InBandBytestreamManager#getByteStreamManager(XMPPConnection)} returns
- * one bytestream manager for every connection
+ * one bytestream manager for every connection.
*/
@Test
public void shouldHaveOneManagerForEveryConnection() {
diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamManagerTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamManagerTest.java
index ecad7c6b6..faae60a20 100644
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamManagerTest.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamManagerTest.java
@@ -96,7 +96,7 @@ public class Socks5ByteStreamManagerTest {
/**
* Test that {@link Socks5BytestreamManager#getBytestreamManager(XMPPConnection)} returns one
- * bytestream manager for every connection
+ * bytestream manager for every connection.
*/
@Test
public void shouldHaveOneManagerForEveryConnection() {
diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientTest.java
index 8e74614be..44a38e359 100644
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientTest.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientTest.java
@@ -248,7 +248,7 @@ public class Socks5ClientTest {
}
/**
- * The SOCKS5 client should successfully connect to the SOCKS5 server
+ * The SOCKS5 client should successfully connect to the SOCKS5 server.
*
* @throws Exception should not happen
*/
diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ProxyTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ProxyTest.java
index 0116414ef..1f69f865b 100644
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ProxyTest.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ProxyTest.java
@@ -43,7 +43,7 @@ import org.junit.Test;
public class Socks5ProxyTest {
/**
- * The SOCKS5 proxy should be a singleton used by all XMPP connections
+ * The SOCKS5 proxy should be a singleton used by all XMPP connections.
*/
@Test
public void shouldBeASingleton() {
diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5TestProxy.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5TestProxy.java
index d24dea498..d4b2a9662 100644
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5TestProxy.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5TestProxy.java
@@ -69,7 +69,7 @@ public class Socks5TestProxy {
}
/**
- * Returns the local SOCKS5 proxy server
+ * Returns the local SOCKS5 proxy server.
*
* @param port of the test proxy
* @return the local SOCKS5 proxy server
@@ -83,7 +83,7 @@ public class Socks5TestProxy {
}
/**
- * Stops the test proxy
+ * Stops the test proxy.
*/
public static synchronized void stopProxy() {
if (socks5Server != null) {
diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/caps/EntityCapsManagerTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/caps/EntityCapsManagerTest.java
index 5b94685e0..1f82b9191 100644
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/caps/EntityCapsManagerTest.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/caps/EntityCapsManagerTest.java
@@ -44,7 +44,7 @@ public class EntityCapsManagerTest extends InitExtensions {
/**
* XEP-
- * 0115 Complex Generation Example
+ * 0115 Complex Generation Example.
* @throws XmppStringprepException
*/
@Test
diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/pubsub/ConfigureFormTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/pubsub/ConfigureFormTest.java
index 2c153f5c3..698a15e12 100644
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/pubsub/ConfigureFormTest.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/pubsub/ConfigureFormTest.java
@@ -36,7 +36,7 @@ import org.junit.Test;
import org.jxmpp.stringprep.XmppStringprepException;
/**
- *
+ * Configure form test.
* @author Robin Collier
*
*/
diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/pubsub/ItemValidationTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/pubsub/ItemValidationTest.java
index 564d0fbf3..c870f139d 100644
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/pubsub/ItemValidationTest.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/pubsub/ItemValidationTest.java
@@ -32,7 +32,7 @@ import org.junit.Test;
import org.xmlpull.v1.XmlPullParser;
/**
- *
+ * Item validation test.
* @author Robin Collier
*
*/
diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/xdatavalidation/DataValidationHelperTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/xdatavalidation/DataValidationHelperTest.java
index 3d853216f..e5495e95d 100644
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/xdatavalidation/DataValidationHelperTest.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/xdatavalidation/DataValidationHelperTest.java
@@ -29,7 +29,7 @@ import org.jivesoftware.smackx.xdatavalidation.packet.ValidateElement.RegexValid
import org.junit.Test;
/**
- *
+ * Data validation helper test.
* @author Anno van Vliet
*
*/
diff --git a/smack-extensions/src/test/java/org/jivesoftware/smackx/xdatavalidation/provider/DataValidationTest.java b/smack-extensions/src/test/java/org/jivesoftware/smackx/xdatavalidation/provider/DataValidationTest.java
index 9e91c0a30..c9224c2da 100644
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/xdatavalidation/provider/DataValidationTest.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/xdatavalidation/provider/DataValidationTest.java
@@ -32,7 +32,7 @@ import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
/**
- *
+ * Data validation test.
* @author Anno van Vliet
*
*/
diff --git a/smack-im/src/main/java/org/jivesoftware/smack/chat/ChatMessageListener.java b/smack-im/src/main/java/org/jivesoftware/smack/chat/ChatMessageListener.java
index c1f178259..4ca62bbb0 100644
--- a/smack-im/src/main/java/org/jivesoftware/smack/chat/ChatMessageListener.java
+++ b/smack-im/src/main/java/org/jivesoftware/smack/chat/ChatMessageListener.java
@@ -19,9 +19,6 @@ package org.jivesoftware.smack.chat;
import org.jivesoftware.smack.packet.Message;
-/**
- *
- */
public interface ChatMessageListener {
void processMessage(Chat chat, Message message);
}
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 3469c78bb..f77f5d7e4 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
@@ -323,7 +323,7 @@ public class Roster extends Manager {
}
/**
- * Set the roster store, may cause a roster reload
+ * Set the roster store, may cause a roster reload.
*
* @param rosterStore
* @return true if the roster reload was initiated, false otherwise.
diff --git a/smack-im/src/main/java/org/jivesoftware/smack/roster/packet/RosterPacket.java b/smack-im/src/main/java/org/jivesoftware/smack/roster/packet/RosterPacket.java
index e9b5197de..b2bc99431 100644
--- a/smack-im/src/main/java/org/jivesoftware/smack/roster/packet/RosterPacket.java
+++ b/smack-im/src/main/java/org/jivesoftware/smack/roster/packet/RosterPacket.java
@@ -311,12 +311,12 @@ public class RosterPacket extends IQ {
*/
public static enum ItemStatus {
/**
- * Request to subscribe
+ * Request to subscribe.
*/
subscribe,
/**
- * Request to unsubscribe
+ * Request to unsubscribe.
*/
unsubscribe;
diff --git a/smack-im/src/main/java/org/jivesoftware/smack/roster/rosterstore/DirectoryRosterStore.java b/smack-im/src/main/java/org/jivesoftware/smack/roster/rosterstore/DirectoryRosterStore.java
index ab42aedf7..e71622746 100644
--- a/smack-im/src/main/java/org/jivesoftware/smack/roster/rosterstore/DirectoryRosterStore.java
+++ b/smack-im/src/main/java/org/jivesoftware/smack/roster/rosterstore/DirectoryRosterStore.java
@@ -75,7 +75,7 @@ public class DirectoryRosterStore implements RosterStore {
}
/**
- * Creates a new roster store on disk
+ * Creates a new roster store on disk.
*
* @param baseDir
* The directory to create the store in. The directory should
@@ -94,7 +94,7 @@ public class DirectoryRosterStore implements RosterStore {
}
/**
- * Opens a roster store
+ * Opens a roster store.
* @param baseDir
* The directory containing the roster store.
* @return A {@link DirectoryRosterStore} instance if successful,
diff --git a/smack-im/src/main/java/org/jivesoftware/smack/roster/rosterstore/RosterStore.java b/smack-im/src/main/java/org/jivesoftware/smack/roster/rosterstore/RosterStore.java
index f99a7d0e3..b9c7b30b1 100644
--- a/smack-im/src/main/java/org/jivesoftware/smack/roster/rosterstore/RosterStore.java
+++ b/smack-im/src/main/java/org/jivesoftware/smack/roster/rosterstore/RosterStore.java
@@ -60,7 +60,7 @@ public interface RosterStore {
*/
public boolean resetEntries(Collection items, String version);
/**
- * Removes an entry from the store
+ * Removes an entry from the store.
* @param bareJid The bare JID of the entry to be removed
* @param version the new roster version
* @return True if successful
diff --git a/smack-im/src/test/java/org/jivesoftware/smack/roster/RosterVersioningTest.java b/smack-im/src/test/java/org/jivesoftware/smack/roster/RosterVersioningTest.java
index ab968816e..311b5078e 100644
--- a/smack-im/src/test/java/org/jivesoftware/smack/roster/RosterVersioningTest.java
+++ b/smack-im/src/test/java/org/jivesoftware/smack/roster/RosterVersioningTest.java
@@ -49,7 +49,7 @@ import org.jxmpp.stringprep.XmppStringprepException;
/**
* Tests that verify the correct behavior of the {@link Roster} implementation
- * with regard to roster versioning
+ * with regard to roster versioning.
*
* @see Roster
* @see Managing the Roster
@@ -172,7 +172,7 @@ public class RosterVersioningTest {
}
/**
- * Test roster versioning with roster pushes
+ * Test roster versioning with roster pushes.
*/
@Test(timeout = 5000)
public void testRosterVersioningWithCachedRosterAndPushes() throws Throwable {
diff --git a/smack-im/src/test/java/org/jivesoftware/smack/roster/rosterstore/DirectoryRosterStoreTest.java b/smack-im/src/test/java/org/jivesoftware/smack/roster/rosterstore/DirectoryRosterStoreTest.java
index d48010d31..aae9a12e2 100644
--- a/smack-im/src/test/java/org/jivesoftware/smack/roster/rosterstore/DirectoryRosterStoreTest.java
+++ b/smack-im/src/test/java/org/jivesoftware/smack/roster/rosterstore/DirectoryRosterStoreTest.java
@@ -79,7 +79,7 @@ public class DirectoryRosterStoreTest {
}
/**
- * Tests adding and removing entries
+ * Tests adding and removing entries.
*/
@Test
public void testStoreAddRemove() throws IOException {
diff --git a/smack-java7/src/main/java/org/jivesoftware/smack/util/stringencoder/java7/Base64.java b/smack-java7/src/main/java/org/jivesoftware/smack/util/stringencoder/java7/Base64.java
index ca2f92fa1..6aa7d3cb7 100644
--- a/smack-java7/src/main/java/org/jivesoftware/smack/util/stringencoder/java7/Base64.java
+++ b/smack-java7/src/main/java/org/jivesoftware/smack/util/stringencoder/java7/Base64.java
@@ -49,7 +49,7 @@ public class Base64
public final static int GZIP = 2;
- /** Don't break lines when encoding (violates strict Base64 specification) */
+ /** Don't break lines when encoding (violates strict Base64 specification). */
public final static int DONT_BREAK_LINES = 8;
/**
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/ContentNegotiator.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/ContentNegotiator.java
index 33de499bf..48f596875 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/ContentNegotiator.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/ContentNegotiator.java
@@ -36,6 +36,8 @@ import org.jivesoftware.smackx.jingleold.packet.Jingle;
import org.jivesoftware.smackx.jingleold.packet.JingleContent;
/**
+ * Content negotiator.
+ *
* @author Jeff Williams
*/
public class ContentNegotiator extends JingleNegotiator {
@@ -106,7 +108,7 @@ public class ContentNegotiator extends JingleNegotiator {
}
/**
- * Get the JingleMediaSession of this Jingle Session
+ * Get the JingleMediaSession of this Jingle Session.
*
* @return the JingleMediaSession
*/
@@ -119,6 +121,7 @@ public class ContentNegotiator extends JingleNegotiator {
}
/**
+ * Set jingle transport manager.
* @param jingleTransportManager
*/
public void setJingleTransportManager(JingleTransportManager jingleTransportManager) {
@@ -126,6 +129,7 @@ public class ContentNegotiator extends JingleNegotiator {
}
/**
+ * Get jingle transport manager.
* @return the JingleTransportManager
*/
public JingleTransportManager getTransportManager() {
@@ -156,7 +160,7 @@ public class ContentNegotiator extends JingleNegotiator {
}
/**
- * Obtain the description negotiator for this session
+ * Obtain the description negotiator for this session.
*
* @return the description negotiator
*/
@@ -216,7 +220,7 @@ public class ContentNegotiator extends JingleNegotiator {
}
/**
- * Return true if the transport and content negotiators have finished
+ * Return true if the transport and content negotiators have finished.
*/
public boolean isFullyEstablished() {
boolean result = true;
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleManager.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleManager.java
index d3de491ec..a132eaa8b 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleManager.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleManager.java
@@ -204,7 +204,7 @@ public class JingleManager implements JingleSessionListener {
private List jingleMediaManagers;
/**
- * Default constructor with a defined XMPPConnection, Transport Resolver and a Media Manager
+ * Default constructor with a defined XMPPConnection, Transport Resolver and a Media Manager.
* If a fully implemented JingleMediaSession is entered, JingleManager manage Jingle signalling and jmf
*
* @param connection XMPP XMPPConnection to be used
@@ -321,7 +321,7 @@ public class JingleManager implements JingleSessionListener {
}
/**
- * Get the Media Managers of this Jingle Manager
+ * Get the Media Managers of this Jingle Manager.
*
* @return the list of JingleMediaManagers
*/
@@ -330,7 +330,7 @@ public class JingleManager implements JingleSessionListener {
}
/**
- * Set the Media Managers of this Jingle Manager
+ * Set the Media Managers of this Jingle Manager.
*
* @param jingleMediaManagers JingleMediaManager to be used for open, close, start and stop jmf streamings
*/
@@ -473,7 +473,7 @@ public class JingleManager implements JingleSessionListener {
}
/**
- * Disconnect all Jingle Sessions
+ * Disconnect all Jingle Sessions.
*/
public void disconnectAllSessions() {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleNegotiator.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleNegotiator.java
index f8965ecac..0cb75fd45 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleNegotiator.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleNegotiator.java
@@ -64,7 +64,7 @@ public abstract class JingleNegotiator {
}
/**
- * Default constructor with a Connection
+ * Default constructor with a Connection.
*
* @param session the jingle session
*/
@@ -129,7 +129,7 @@ public abstract class JingleNegotiator {
// Acks management
/**
- * Add expected ID
+ * Add expected ID.
*
* @param id
*/
@@ -138,7 +138,7 @@ public abstract class JingleNegotiator {
}
/**
- * Check if the passed ID is the expected ID
+ * Check if the passed ID is the expected ID.
*
* @param id
* @return true if is expected id
@@ -152,7 +152,7 @@ public abstract class JingleNegotiator {
}
/**
- * Remove and expected ID
+ * Remove and expected ID.
*
* @param id
*/
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleNegotiatorState.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleNegotiatorState.java
index c955838f7..69887e901 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleNegotiatorState.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleNegotiatorState.java
@@ -17,6 +17,7 @@
package org.jivesoftware.smackx.jingleold;
/**
+ * Jingle negotiator state.
* @author Jeff Williams
*/
public enum JingleNegotiatorState {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSession.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSession.java
index 1a22769e3..fc10ee8f9 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSession.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSession.java
@@ -96,7 +96,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
private Map mediaSessionMap;
/**
- * Full featured JingleSession constructor
+ * Full featured JingleSession constructor.
*
* @param conn
* the XMPPConnection which is used
@@ -132,7 +132,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
- * JingleSession constructor (for an outgoing Jingle session)
+ * JingleSession constructor (for an outgoing Jingle session).
*
* @param conn
* Connection
@@ -150,7 +150,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
- * Get the session initiator
+ * Get the session initiator.
*
* @return the initiator
*/
@@ -163,7 +163,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
- * Set the session initiator
+ * Set the session initiator.
*
* @param initiator
* the initiator to set
@@ -173,7 +173,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
- * Get the Media Manager of this Jingle Session
+ * Get the Media Manager of this Jingle Session.
*
* @return the JingleMediaManagers
*/
@@ -182,7 +182,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
- * Set the Media Manager of this Jingle Session
+ * Set the Media Manager of this Jingle Session.
*
* @param jingleMediaManagers
*/
@@ -191,7 +191,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
- * Get the session responder
+ * Get the session responder.
*
* @return the responder
*/
@@ -210,7 +210,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
- * Get the session ID
+ * Get the session ID.
*
* @return the sid
*/
@@ -251,7 +251,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
- * Return true if all of the media managers have finished
+ * Return true if all of the media managers have finished.
*/
public boolean isFullyEstablished() {
boolean result = true;
@@ -740,7 +740,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
// Listeners
/**
- * Add a listener for jmf negotiation events
+ * Add a listener for jmf negotiation events.
*
* @param li
* The listener
@@ -755,7 +755,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
- * Remove a listener for jmf negotiation events
+ * Remove a listener for jmf negotiation events.
*
* @param li
* The listener
@@ -769,7 +769,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
- * Add a listener for transport negotiation events
+ * Add a listener for transport negotiation events.
*
* @param li
* The listener
@@ -783,7 +783,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
- * Remove a listener for transport negotiation events
+ * Remove a listener for transport negotiation events.
*
* @param li
* The listener
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionStateActive.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionStateActive.java
index 6b085c2bc..016eddb20 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionStateActive.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionStateActive.java
@@ -24,6 +24,7 @@ import org.jivesoftware.smackx.jingleold.packet.Jingle;
import org.jivesoftware.smackx.jingleold.packet.JingleError;
/**
+ * Jingle.
* @author Jeff Williams
* @see JingleSessionState
*/
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionStateEnded.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionStateEnded.java
index 9240cf009..c632bcb4a 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionStateEnded.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionStateEnded.java
@@ -23,6 +23,7 @@ import org.jivesoftware.smackx.jingleold.packet.Jingle;
import org.jivesoftware.smackx.jingleold.packet.JingleError;
/**
+ * Jingle.
* @author Jeff Williams
* @see JingleSessionState
*/
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionStatePending.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionStatePending.java
index 860bab8ee..0abe322e5 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionStatePending.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionStatePending.java
@@ -23,6 +23,7 @@ import org.jivesoftware.smack.packet.IQ;
import org.jivesoftware.smackx.jingleold.packet.Jingle;
/**
+ * Jingle.
* @author Jeff Williams
* @see JingleSessionState
*/
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionStateUnknown.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionStateUnknown.java
index 2c29fe7b8..a69439dbf 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionStateUnknown.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionStateUnknown.java
@@ -35,6 +35,7 @@ import org.jivesoftware.smackx.jingleold.packet.JingleError;
import org.jivesoftware.smackx.jingleold.packet.JingleTransport;
/**
+ * Jingle.
* @author Jeff Williams
* @see JingleSessionState
*/
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/listeners/JingleMediaListener.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/listeners/JingleMediaListener.java
index bfdb1f59c..375884a69 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/listeners/JingleMediaListener.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/listeners/JingleMediaListener.java
@@ -35,7 +35,7 @@ public interface JingleMediaListener extends JingleListener {
public void mediaEstablished(PayloadType pt) throws NotConnectedException, InterruptedException;
/**
- * Notification that a payload type must be cancelled
+ * Notification that a payload type must be cancelled.
*
* @param cand The payload type that must be closed
*/
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/JingleMediaManager.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/JingleMediaManager.java
index c5157472d..b1b38f734 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/JingleMediaManager.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/JingleMediaManager.java
@@ -51,14 +51,14 @@ public abstract class JingleMediaManager {
}
/**
- * Return all supported Payloads for this Manager
+ * Return all supported Payloads for this Manager.
*
* @return The Payload List
*/
public abstract List getPayloads();
/**
- * Returns the Preferred PayloadType of the Media Manager
+ * Returns the Preferred PayloadType of the Media Manager.
*
* @return The PayloadType
*/
@@ -67,7 +67,7 @@ public abstract class JingleMediaManager {
}
/**
- * Create a Media Session Implementation
+ * Create a Media Session Implementation.
*
* @param payloadType
* @param remote
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/JingleMediaSession.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/JingleMediaSession.java
index ddd94ab31..754a6a2ad 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/JingleMediaSession.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/JingleMediaSession.java
@@ -67,7 +67,7 @@ public abstract class JingleMediaSession {
}
/**
- * Returns the PayloadType of the Media Session
+ * Returns the PayloadType of the Media Session.
*
* @return the PayloadType
*/
@@ -76,7 +76,7 @@ public abstract class JingleMediaSession {
}
/**
- * Returns the Media Session local Candidate
+ * Returns the Media Session local Candidate.
*
* @return the TransportCandidate
*/
@@ -85,7 +85,7 @@ public abstract class JingleMediaSession {
}
/**
- * Returns the Media Session remote Candidate
+ * Returns the Media Session remote Candidate.
*
* @return the TransportCandidate
*/
@@ -94,7 +94,7 @@ public abstract class JingleMediaSession {
}
/**
- * Return the media locator or null if not defined
+ * Return the media locator or null if not defined.
*
* @return media locator
*/
@@ -103,7 +103,7 @@ public abstract class JingleMediaSession {
}
/**
- * Set the media locator
+ * Set the media locator.
*
* @param mediaLocator media locator or null to use default
*/
@@ -112,7 +112,7 @@ public abstract class JingleMediaSession {
}
/**
- * Adds a Media Received Listener
+ * Adds a Media Received Listener.
*
* @param mediaReceivedListener
*/
@@ -121,7 +121,7 @@ public abstract class JingleMediaSession {
}
/**
- * Removes a Media Received Listener
+ * Removes a Media Received Listener.
*
* @param mediaReceivedListener
*/
@@ -130,7 +130,7 @@ public abstract class JingleMediaSession {
}
/**
- * Removes all Media Received Listeners
+ * Removes all Media Received Listeners.
*/
public void removeAllMediaReceivedListener() {
mediaReceivedListeners.clear();
@@ -142,12 +142,12 @@ public abstract class JingleMediaSession {
public abstract void initialize();
/**
- * Starts a RTP / UDP / TCP Transmission to the remote Candidate
+ * Starts a RTP / UDP / TCP Transmission to the remote Candidate.
*/
public abstract void startTrasmit();
/**
- * Starts a RTP / UDP / TCP Receiver from the remote Candidate to local Candidate
+ * Starts a RTP / UDP / TCP Receiver from the remote Candidate to local Candidate.
*/
public abstract void startReceive();
@@ -160,12 +160,12 @@ public abstract class JingleMediaSession {
public abstract void setTrasmit(boolean active);
/**
- * Stops a RTP / UDP / TCP Transmission to the remote Candidate
+ * Stops a RTP / UDP / TCP Transmission to the remote Candidate.
*/
public abstract void stopTrasmit();
/**
- * Stops a RTP / UDP / TCP Receiver from the remote Candidate to local Candidate
+ * Stops a RTP / UDP / TCP Receiver from the remote Candidate to local Candidate.
*/
public abstract void stopReceive();
@@ -179,7 +179,7 @@ public abstract class JingleMediaSession {
}
/**
- * Gets associated JingleSession
+ * Gets associated JingleSession.
* @return associated JingleSession
*/
public JingleSession getJingleSession() {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/MediaNegotiator.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/MediaNegotiator.java
index 69c7b1425..807a58484 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/MediaNegotiator.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/MediaNegotiator.java
@@ -515,7 +515,7 @@ public class MediaNegotiator extends JingleNegotiator {
}
/**
- * Terminate the jmf negotiator
+ * Terminate the jmf negotiator.
*/
public void close() {
super.close();
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/MediaReceivedListener.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/MediaReceivedListener.java
index 69a17f529..5c564a722 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/MediaReceivedListener.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/MediaReceivedListener.java
@@ -17,7 +17,7 @@
package org.jivesoftware.smackx.jingleold.media;
/**
- * Listener for new Incoming Media Streams
+ * Listener for new Incoming Media Streams.
*/
public interface MediaReceivedListener {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/PayloadType.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/PayloadType.java
index b29bff5f7..2b0a1d84b 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/PayloadType.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/PayloadType.java
@@ -36,7 +36,7 @@ public class PayloadType {
private int channels;
/**
- * Constructor with Id, name and number of channels
+ * Constructor with Id, name and number of channels.
*
* @param id The identifier
* @param name A name
@@ -57,7 +57,7 @@ public class PayloadType {
}
/**
- * Constructor with Id and name
+ * Constructor with Id and name.
*
* @param id The identification
* @param name A name
@@ -67,7 +67,7 @@ public class PayloadType {
}
/**
- * Copy constructor
+ * Copy constructor.
*
* @param pt The other payload type.
*/
@@ -130,7 +130,7 @@ public class PayloadType {
}
/**
- * Return true if the Payload type is not valid
+ * Return true if the Payload type is not valid.
*
* @return true if the payload type is invalid
*/
@@ -247,7 +247,7 @@ public class PayloadType {
private int clockRate;
/**
- * Constructor with all the attributes of an Audio payload type
+ * Constructor with all the attributes of an Audio payload type.
*
* @param id The identifier
* @param name The name assigned to this payload type
@@ -260,7 +260,7 @@ public class PayloadType {
}
/**
- * Constructor with all the attributes of an Audio payload type
+ * Constructor with all the attributes of an Audio payload type.
*
* @param id The identifier
* @param name The name assigned to this payload type
@@ -280,7 +280,7 @@ public class PayloadType {
}
/**
- * Constructor with Id and name
+ * Constructor with Id and name.
*
* @param id the Id for the payload type
* @param name the name of the payload type
@@ -291,7 +291,7 @@ public class PayloadType {
}
/**
- * Copy constructor
+ * Copy constructor.
*
* @param pt the other payload type
*/
@@ -301,7 +301,7 @@ public class PayloadType {
}
/**
- * Copy constructor
+ * Copy constructor.
*
* @param pt the other payload type
*/
@@ -311,7 +311,7 @@ public class PayloadType {
}
/**
- * Get the sampling clockRate for a payload type
+ * Get the sampling clockRate for a payload type.
*
* @return The sampling clockRate
*/
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/AudioMediaSession.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/AudioMediaSession.java
index d8f74a0f7..0347ee9d9 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/AudioMediaSession.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/AudioMediaSession.java
@@ -45,7 +45,7 @@ public class AudioMediaSession extends JingleMediaSession {
private AudioChannel audioChannel;
/**
- * Creates a org.jivesoftware.jingleaudio.jmf.AudioMediaSession with defined payload type, remote and local candidates
+ * Creates a org.jivesoftware.jingleaudio.jmf.AudioMediaSession with defined payload type, remote and local candidates.
*
* @param payloadType Payload of the jmf
* @param remote the remote information. The candidate that the jmf will be sent to.
@@ -59,7 +59,7 @@ public class AudioMediaSession extends JingleMediaSession {
}
/**
- * Initialize the Audio Channel to make it able to send and receive audio
+ * Initialize the Audio Channel to make it able to send and receive audio.
*/
public void initialize() {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/AudioReceiver.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/AudioReceiver.java
index d8421b503..a82b3633b 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/AudioReceiver.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/AudioReceiver.java
@@ -40,7 +40,7 @@ import javax.media.rtp.event.StreamMappedEvent;
import org.jivesoftware.smackx.jingleold.media.JingleMediaSession;
/**
- * This class implements receive methods and listeners to be used in AudioChannel
+ * This class implements receive methods and listeners to be used in AudioChannel.
*
* @author Thiago Camargo
*/
@@ -70,7 +70,7 @@ public class AudioReceiver implements ReceiveStreamListener, SessionListener,
}
/**
- * ReceiveStreamListener
+ * ReceiveStreamListener.
*/
public synchronized void update(ReceiveStreamEvent evt) {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/JmfMediaManager.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/JmfMediaManager.java
index bd4bb5e01..af4b99493 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/JmfMediaManager.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/JmfMediaManager.java
@@ -49,7 +49,7 @@ public class JmfMediaManager extends JingleMediaManager {
private String mediaLocator = null;
/**
- * Creates a Media Manager instance
+ * Creates a Media Manager instance.
*/
public JmfMediaManager(JingleTransportManager transportManager) {
super(transportManager);
@@ -57,7 +57,7 @@ public class JmfMediaManager extends JingleMediaManager {
}
/**
- * Creates a Media Manager instance
+ * Creates a Media Manager instance.
*
* @param mediaLocator Media Locator
*/
@@ -68,7 +68,7 @@ public class JmfMediaManager extends JingleMediaManager {
}
/**
- * Returns a new jingleMediaSession
+ * Returns a new jingleMediaSession.
*
* @param payloadType payloadType
* @param remote remote Candidate
@@ -89,7 +89,7 @@ public class JmfMediaManager extends JingleMediaManager {
}
/**
- * Return all supported Payloads for this Manager
+ * Return all supported Payloads for this Manager.
*
* @return The Payload List
*/
@@ -98,7 +98,7 @@ public class JmfMediaManager extends JingleMediaManager {
}
/**
- * Return the media locator or null if not defined
+ * Return the media locator or null if not defined.
*
* @return media locator
*/
@@ -107,7 +107,7 @@ public class JmfMediaManager extends JingleMediaManager {
}
/**
- * Set the media locator
+ * Set the media locator.
*
* @param mediaLocator media locator or null to use default
*/
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jspeex/AudioMediaSession.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jspeex/AudioMediaSession.java
index 1ac18bda1..51d95fa7b 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jspeex/AudioMediaSession.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jspeex/AudioMediaSession.java
@@ -57,7 +57,7 @@ public class AudioMediaSession extends JingleMediaSession implements MediaSessio
private MediaSession mediaSession;
/**
- * Create a Session using Speex Codec
+ * Create a Session using Speex Codec.
*
* @param localhost localHost
* @param localPort localPort
@@ -96,7 +96,7 @@ public class AudioMediaSession extends JingleMediaSession implements MediaSessio
/**
- * Creates a org.jivesoftware.jingleaudio.jspeex.AudioMediaSession with defined payload type, remote and local candidates
+ * Creates a org.jivesoftware.jingleaudio.jspeex.AudioMediaSession with defined payload type, remote and local candidates.
*
* @param payloadType Payload of the jmf
* @param remote the remote information. The candidate that the jmf will be sent to.
@@ -110,7 +110,7 @@ public class AudioMediaSession extends JingleMediaSession implements MediaSessio
}
/**
- * Initialize the Audio Channel to make it able to send and receive audio
+ * Initialize the Audio Channel to make it able to send and receive audio.
*/
public void initialize() {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jspeex/SpeexMediaManager.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jspeex/SpeexMediaManager.java
index ffd53f85e..50ec237c6 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jspeex/SpeexMediaManager.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jspeex/SpeexMediaManager.java
@@ -53,7 +53,7 @@ public class SpeexMediaManager extends JingleMediaManager {
}
/**
- * Returns a new jingleMediaSession
+ * Returns a new jingleMediaSession.
*
* @param payloadType payloadType
* @param remote remote Candidate
@@ -72,7 +72,7 @@ public class SpeexMediaManager extends JingleMediaManager {
}
/**
- * Return all supported Payloads for this Manager
+ * Return all supported Payloads for this Manager.
*
* @return The Payload List
*/
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/multi/MultiMediaManager.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/multi/MultiMediaManager.java
index 1340c2555..d8e094e7b 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/multi/MultiMediaManager.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/multi/MultiMediaManager.java
@@ -71,7 +71,7 @@ public class MultiMediaManager extends JingleMediaManager {
}
/**
- * Returns a new JingleMediaSession
+ * Returns a new JingleMediaSession.
*
* @param payloadType payloadType
* @param remote remote Candidate
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/ScreenShareMediaManager.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/ScreenShareMediaManager.java
index e1ac80d12..8a5efa4b2 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/ScreenShareMediaManager.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/ScreenShareMediaManager.java
@@ -66,7 +66,7 @@ public class ScreenShareMediaManager extends JingleMediaManager {
}
/**
- * Returns a new JingleMediaSession
+ * Returns a new JingleMediaSession.
*
* @param payloadType payloadType
* @param remote remote Candidate
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/ScreenShareSession.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/ScreenShareSession.java
index 644e9d3f1..4b0bcce45 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/ScreenShareSession.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/ScreenShareSession.java
@@ -58,7 +58,7 @@ public class ScreenShareSession extends JingleMediaSession {
private int height = 600;
/**
- * Creates a org.jivesoftware.jingleaudio.jmf.AudioMediaSession with defined payload type, remote and local candidates
+ * Creates a org.jivesoftware.jingleaudio.jmf.AudioMediaSession with defined payload type, remote and local candidates.
*
* @param payloadType Payload of the jmf
* @param remote the remote information. The candidate that the jmf will be sent to.
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/DefaultEncoder.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/DefaultEncoder.java
index 53e21d13f..79f387361 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/DefaultEncoder.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/DefaultEncoder.java
@@ -25,7 +25,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
- * Implements a default PNG Encoder
+ * Implements a default PNG Encoder.
*/
public class DefaultEncoder implements ImageEncoder{
private static final Logger LOGGER = Logger.getLogger(DefaultEncoder.class.getName());
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/ImageDecoder.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/ImageDecoder.java
index 69b9b307d..10abde173 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/ImageDecoder.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/ImageDecoder.java
@@ -21,7 +21,7 @@ import java.io.ByteArrayInputStream;
import java.io.IOException;
/**
- * Image Decoder Interface use this interface if you want to change the default decoder
+ * Image Decoder Interface use this interface if you want to change the default decoder.
*
* @author Thiago Rocha Camargo
*/
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/ImageEncoder.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/ImageEncoder.java
index 1eac94ad9..034574d7d 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/ImageEncoder.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/ImageEncoder.java
@@ -20,7 +20,7 @@ import java.awt.image.BufferedImage;
import java.io.ByteArrayOutputStream;
/**
- * Image Encoder Interface use this interface if you want to change the default encoder
+ * Image Encoder Interface use this interface if you want to change the default encoder.
*
* @author Thiago Rocha Camargo
*/
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/ImageTransmitter.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/ImageTransmitter.java
index 0de0e60f6..0f1392e29 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/ImageTransmitter.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/ImageTransmitter.java
@@ -183,7 +183,7 @@ public class ImageTransmitter implements Runnable {
}
/**
- * Set Transmit Enabled/Disabled
+ * Set Transmit Enabled/Disabled.
*
* @param transmit boolean Enabled/Disabled
*/
@@ -192,7 +192,7 @@ public class ImageTransmitter implements Runnable {
}
/**
- * Get the encoder used to encode Images Tiles
+ * Get the encoder used to encode Images Tiles.
*
* @return encoder
*/
@@ -201,7 +201,7 @@ public class ImageTransmitter implements Runnable {
}
/**
- * Set the encoder used to encode Image Tiles
+ * Set the encoder used to encode Image Tiles.
*
* @param encoder encoder
*/
@@ -210,7 +210,7 @@ public class ImageTransmitter implements Runnable {
}
/**
- * Stops Transmitter
+ * Stops Transmitter.
*/
public void stop() {
this.transmit = false;
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/PixelUtils.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/PixelUtils.java
index 117ec500e..20946dd66 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/PixelUtils.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/PixelUtils.java
@@ -51,7 +51,7 @@ public class PixelUtils {
private static Random randomGenerator = new Random();
/**
- * Clamp a value to the range 0..255
+ * Clamp a value to the range 0..255.
*/
public static int clamp(int c) {
if (c < 0)
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/QuantizeFilter.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/QuantizeFilter.java
index 3543bd538..c1dbf0a38 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/QuantizeFilter.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/sshare/api/QuantizeFilter.java
@@ -68,7 +68,7 @@ public class QuantizeFilter extends WholeImageFilter {
}
/**
- * Return the dithering setting
+ * Return the dithering setting.
* @return the current setting
*/
public boolean getDither() {
@@ -84,7 +84,7 @@ public class QuantizeFilter extends WholeImageFilter {
}
/**
- * Return the serpentine setting
+ * Return the serpentine setting.
* @return the current setting
*/
public boolean getSerpentine() {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/test/TestMediaManager.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/test/TestMediaManager.java
index 63ead7bd1..4fe57ff33 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/test/TestMediaManager.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/test/TestMediaManager.java
@@ -58,7 +58,7 @@ public class TestMediaManager extends JingleMediaManager {
}
/**
- * Returns a new JingleMediaSession
+ * Returns a new JingleMediaSession.
*
* @param payloadType payloadType
* @param remote remote Candidate
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/test/TestMediaSession.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/test/TestMediaSession.java
index 4e83a34b8..8e9cc30a9 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/test/TestMediaSession.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/test/TestMediaSession.java
@@ -29,7 +29,7 @@ import org.jivesoftware.smackx.jingleold.nat.TransportCandidate;
public class TestMediaSession extends JingleMediaSession {
/**
- * Creates a TestMediaSession with defined payload type, remote and local candidates
+ * Creates a TestMediaSession with defined payload type, remote and local candidates.
*
* @param payloadType Payload of the jmf
* @param remote the remote information. The candidate that the jmf will be sent to.
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/HttpServer.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/HttpServer.java
index 5973ce262..a4207fb99 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/HttpServer.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/HttpServer.java
@@ -28,7 +28,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
- * A very Simple HTTP Server
+ * A very Simple HTTP Server.
*/
public class HttpServer {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/ICECandidate.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/ICECandidate.java
index 7ba4e8cb5..f89d1d70a 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/ICECandidate.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/ICECandidate.java
@@ -86,7 +86,7 @@ public class ICECandidate extends TransportCandidate implements Comparable
*/
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportResolver.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportResolver.java
index ee5c7f57f..3ce8370e6 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportResolver.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportResolver.java
@@ -88,7 +88,7 @@ public abstract class TransportResolver {
}
/**
- * Initialize the Resolver
+ * Initialize the Resolver.
* @throws InterruptedException
*/
public abstract void initialize() throws XMPPException, SmackException, InterruptedException;
@@ -141,7 +141,7 @@ public abstract class TransportResolver {
}
/**
- * Chack if the Transport Resolver is initialized
+ * Chack if the Transport Resolver is initialized.
*
* @return true if initialized
*/
@@ -196,7 +196,7 @@ public abstract class TransportResolver {
}
/**
- * Get the list of listeners
+ * Get the list of listeners.
*
* @return the list of listeners
*/
@@ -282,7 +282,7 @@ public abstract class TransportResolver {
}
/**
- * Get an iterator for the list of candidates
+ * Get an iterator for the list of candidates.
*
* @return an iterator
*/
@@ -329,7 +329,7 @@ public abstract class TransportResolver {
}
/**
- * Get the list of candidates
+ * Get the list of candidates.
*
* @return the list of transport candidates
*/
@@ -344,7 +344,7 @@ public abstract class TransportResolver {
}
/**
- * Get the n-th candidate
+ * Get the n-th candidate.
*
* @return a transport candidate
*/
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportResolverListener.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportResolverListener.java
index 9600cb090..c57801781 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportResolverListener.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportResolverListener.java
@@ -19,7 +19,7 @@ package org.jivesoftware.smackx.jingleold.nat;
import org.jivesoftware.smack.SmackException.NotConnectedException;
/**
- * Transport resolver Interface
+ * Transport resolver Interface .
*/
public abstract interface TransportResolverListener {
/**
@@ -32,7 +32,7 @@ public abstract interface TransportResolverListener {
public void init();
/**
- * A transport candidate has been added
+ * A transport candidate has been added.
*
* @param cand The transport candidate.
* @throws NotConnectedException
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/Jingle.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/Jingle.java
index 84f4c2b08..e8b20ebee 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/Jingle.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/Jingle.java
@@ -144,7 +144,7 @@ public class Jingle extends IQ {
}
/**
- * The default constructor
+ * The default constructor.
*/
public Jingle() {
super(NODENAME, NAMESPACE);
@@ -196,21 +196,25 @@ public class Jingle extends IQ {
}
/**
- * @return the audioInfo
+ * Jingle content info.
+ *
+ * @return the audioInfo.
*/
public JingleContentInfo getContentInfo() {
return contentInfo;
}
/**
- * @param contentInfo the audioInfo to set
+ * Set content info.
+ *
+ * @param contentInfo the audioInfo to set.
*/
public void setContentInfo(final JingleContentInfo contentInfo) {
this.contentInfo = contentInfo;
}
/**
- * Get an iterator for the contents
+ * Get an iterator for the contents.
*
* @return the contents
*/
@@ -221,7 +225,7 @@ public class Jingle extends IQ {
}
/**
- * Get an iterator for the content
+ * Get an iterator for the content.
*
* @return the contents
*/
@@ -245,7 +249,7 @@ public class Jingle extends IQ {
}
/**
- * Add a list of JingleContent elements
+ * Add a list of JingleContent elements.
*
* @param contentList the list of contents to add
*/
@@ -258,7 +262,7 @@ public class Jingle extends IQ {
}
/**
- * Get the action specified in the packet
+ * Get the action specified in the packet.
*
* @return the action
*/
@@ -267,7 +271,7 @@ public class Jingle extends IQ {
}
/**
- * Set the action in the packet
+ * Set the action in the packet.
*
* @param action the action to set
*/
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleContentDescription.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleContentDescription.java
index 1fca00466..d746f1cc0 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleContentDescription.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleContentDescription.java
@@ -165,7 +165,7 @@ public abstract class JingleContentDescription implements ExtensionElement {
}
/**
- * Jingle audio description
+ * Jingle audio description.
*/
public static class Audio extends JingleContentDescription {
@@ -176,7 +176,7 @@ public abstract class JingleContentDescription implements ExtensionElement {
}
/**
- * Utility constructor, with a JinglePayloadType
+ * Utility constructor, with a JinglePayloadType.
*/
public Audio(final JinglePayloadType pt) {
super();
@@ -272,7 +272,7 @@ public abstract class JingleContentDescription implements ExtensionElement {
}
/**
- * Audio payload type element
+ * Audio payload type element.
*/
public static class Audio extends JinglePayloadType {
public Audio(final PayloadType.Audio audio) {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleContentInfo.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleContentInfo.java
index 3e32b794b..e8369a3a4 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleContentInfo.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleContentInfo.java
@@ -20,7 +20,7 @@ import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smackx.jingleold.media.ContentInfo;
/**
- * Jingle content info
+ * Jingle content info.
*
* @author Alvaro Saurin
*/
@@ -38,7 +38,7 @@ public class JingleContentInfo implements ExtensionElement {
}
/**
- * Constructor with a jmf info
+ * Constructor with a jmf info.
*
* @param mediaInfoElement MediaInfo element
*/
@@ -57,7 +57,7 @@ public class JingleContentInfo implements ExtensionElement {
}
/**
- * Get the element name
+ * Get the element name.
*/
public String getElementName() {
// Media info is supposed to be just a single-word command...
@@ -74,7 +74,7 @@ public class JingleContentInfo implements ExtensionElement {
}
/**
- * Get the publilc namespace
+ * Get the publilc namespace.
*/
public String getNamespace() {
return namespace;
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleDescription.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleDescription.java
index 1e9ab2c31..eb0b34d59 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleDescription.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleDescription.java
@@ -172,7 +172,7 @@ public abstract class JingleDescription implements ExtensionElement {
}
/**
- * Jingle audio description
+ * Jingle audio description.
*/
public static class Audio extends JingleDescription {
@@ -183,7 +183,7 @@ public abstract class JingleDescription implements ExtensionElement {
}
/**
- * Utility constructor, with a PayloadType
+ * Utility constructor, with a PayloadType.
*/
public Audio(final PayloadType pt) {
super();
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleTransport.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleTransport.java
index 67d6e72a1..c1117cdfa 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleTransport.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleTransport.java
@@ -26,7 +26,7 @@ import java.util.Iterator;
import java.util.List;
/**
- * A jingle transport extension
+ * A jingle transport extension.
*
* @author Alvaro Saurin
*/
@@ -88,7 +88,7 @@ public class JingleTransport implements ExtensionElement {
}
/**
- * Get an iterator for the candidates
+ * Get an iterator for the candidates.
*
* @return an iterator
*/
@@ -242,7 +242,7 @@ public class JingleTransport implements ExtensionElement {
}
/**
- * Obtain a valid XML representation of a trancport candidate
+ * Obtain a valid XML representation of a trancport candidate.
*
* @return A string containing the XML dump of the transport candidate.
*/
@@ -263,7 +263,7 @@ public class JingleTransport implements ExtensionElement {
// Subclasses
/**
- * RTP-ICE profile
+ * RTP-ICE profile.
*/
public static class Ice extends JingleTransport {
public static final String NAMESPACE = "urn:xmpp:tmp:jingle:transports:ice-udp";
@@ -274,7 +274,7 @@ public class JingleTransport implements ExtensionElement {
}
/**
- * Add a transport candidate
+ * Add a transport candidate.
*
* @see org.jivesoftware.smackx.jingleold.packet.JingleTransport#addCandidate(org.jivesoftware.smackx.jingleold.packet.JingleTransport.JingleTransportCandidate)
*/
@@ -300,7 +300,7 @@ public class JingleTransport implements ExtensionElement {
public static class Candidate extends JingleTransportCandidate {
/**
- * Default constructor
+ * Default constructor.
*/
public Candidate() {
super();
@@ -356,7 +356,7 @@ public class JingleTransport implements ExtensionElement {
}
/**
- * Add a transport candidate
+ * Add a transport candidate.
*
* @see org.jivesoftware.smackx.jingleold.packet.JingleTransport#addCandidate(org.jivesoftware.smackx.jingleold.packet.JingleTransport.JingleTransportCandidate)
*/
@@ -386,7 +386,7 @@ public class JingleTransport implements ExtensionElement {
*/
public static class Candidate extends JingleTransportCandidate {
/**
- * Default constructor
+ * Default constructor.
*/
public Candidate() {
super();
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentDescriptionProvider.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentDescriptionProvider.java
index 966c71dfd..51b1b6d43 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentDescriptionProvider.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentDescriptionProvider.java
@@ -27,7 +27,7 @@ import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
/**
- * Parser for a Jingle description
+ * Parser for a Jingle description.
*
* @author Alvaro Saurin
*/
@@ -101,7 +101,7 @@ public abstract class JingleContentDescriptionProvider extends ExtensionElementP
protected abstract JingleContentDescription getInstance();
/**
- * Jingle audio
+ * Jingle audio.
*/
public static class Audio extends JingleContentDescriptionProvider {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentInfoProvider.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentInfoProvider.java
index 5c492f442..72c9d8681 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentInfoProvider.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentInfoProvider.java
@@ -23,14 +23,14 @@ import org.jivesoftware.smackx.jingleold.packet.JingleContentInfo;
import org.xmlpull.v1.XmlPullParser;
/**
- * Jingle Audio jmf-info provider
+ * Jingle Audio jmf-info provider.
*
* @author Alvaro Saurin
*/
public class JingleContentInfoProvider {
/**
- * JingleDescription.Audio info provider
+ * JingleDescription.Audio info provider.
*/
public static class Audio extends ExtensionElementProvider {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentProvider.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentProvider.java
index 382c743c6..d2e741889 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentProvider.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentProvider.java
@@ -21,7 +21,7 @@ import org.jivesoftware.smackx.jingleold.packet.JingleContent;
import org.xmlpull.v1.XmlPullParser;
/**
- * Jingle provider
+ * Jingle provider.
*
* @author Jeff Williams
*/
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleDescriptionProvider.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleDescriptionProvider.java
index c81b9339c..2adf66960 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleDescriptionProvider.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleDescriptionProvider.java
@@ -26,7 +26,7 @@ import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
/**
- * Parser for a Jingle description
+ * Parser for a Jingle description.
*
* @author Alvaro Saurin
*/
@@ -99,7 +99,7 @@ public abstract class JingleDescriptionProvider extends ExtensionElementProvider
protected abstract JingleDescription getInstance();
/**
- * Jingle audio
+ * Jingle audio.
*/
public static class Audio extends JingleDescriptionProvider {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleProvider.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleProvider.java
index 6e85670a5..0d3db8c4f 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleProvider.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleProvider.java
@@ -17,8 +17,6 @@
package org.jivesoftware.smackx.jingleold.provider;
-import java.io.IOException;
-
import org.jivesoftware.smack.SmackException;
import org.jivesoftware.smack.provider.IQProvider;
import org.jivesoftware.smack.provider.ExtensionElementProvider;
@@ -31,7 +29,6 @@ import org.jivesoftware.smackx.jingleold.packet.JingleDescription;
import org.jivesoftware.smackx.jingleold.packet.JingleTransport;
import org.jxmpp.jid.Jid;
import org.xmlpull.v1.XmlPullParser;
-import org.xmlpull.v1.XmlPullParserException;
/**
* The JingleProvider parses Jingle packets.
@@ -42,9 +39,7 @@ public class JingleProvider extends IQProvider {
/**
* Parse a iq/jingle element.
- * @throws IOException
- * @throws XmlPullParserException
- * @throws SmackException
+ * @throws Exception
*/
@Override
public Jingle parse(XmlPullParser parser, int intialDepth)
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleTransportProvider.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleTransportProvider.java
index 0c2fad5ac..fff7aebe4 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleTransportProvider.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleTransportProvider.java
@@ -28,7 +28,7 @@ import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
/**
- * Provider for a Jingle transport element
+ * Provider for a Jingle transport element.
*
* @author Alvaro Saurin
*/
@@ -83,7 +83,7 @@ public abstract class JingleTransportProvider extends ExtensionElementProvider> getMetaData() {
diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/QueueUser.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/QueueUser.java
index 4077ffe7a..6935247d1 100644
--- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/QueueUser.java
+++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/QueueUser.java
@@ -35,6 +35,8 @@ public class QueueUser {
private Date joinDate;
/**
+ * Queue user.
+ *
* @param uid the user jid of the customer in the queue
* @param position the position customer sits in the queue
* @param time the estimate of how much longer the customer will be in the queue in seconds
@@ -50,6 +52,7 @@ public class QueueUser {
}
/**
+ * Get user id.
* @return the user jid of the customer in the queue
*/
public String getUserID () {
@@ -57,6 +60,7 @@ public class QueueUser {
}
/**
+ * Get queue position.
* @return the position in the queue at which the customer sits, or -1 if the update which
* this instance embodies is only a time update instead
*/
@@ -65,6 +69,7 @@ public class QueueUser {
}
/**
+ * Get the estimated remaining time.
* @return the estimated time remaining of the customer in the queue in seconds, or -1 if
* if the update which this instance embodies is only a position update instead
*/
@@ -73,6 +78,7 @@ public class QueueUser {
}
/**
+ * Get queue join timestamp.
* @return the timestamp of when this customer entered the queue, or null if the server did not
* provide this information
*/
diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/WorkgroupInvitation.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/WorkgroupInvitation.java
index f38b39661..b22f6d825 100644
--- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/WorkgroupInvitation.java
+++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/WorkgroupInvitation.java
@@ -40,7 +40,7 @@ public class WorkgroupInvitation {
protected Map> metaData;
/**
- * This calls the 5-argument constructor with a null MetaData argument value
+ * This calls the 5-argument constructor with a null MetaData argument value.
*
* @param jid the jid string with which the issuing AgentSession or Workgroup instance
* was created
@@ -56,7 +56,8 @@ public class WorkgroupInvitation {
}
/**
- * @param jid the jid string with which the issuing AgentSession or Workgroup instance
+ * WorkgroupInvitation.
+ * @param jid the jid string with which the issuing AgentSession or Workgroup instance.
* was created
* @param group the jid of the room to which the person is invited
* @param workgroup the jid of the workgroup issuing the invitation
@@ -79,6 +80,7 @@ public class WorkgroupInvitation {
}
/**
+ * Get the unique id.
* @return the jid string with which the issuing AgentSession or Workgroup instance
* was created.
*/
@@ -87,7 +89,8 @@ public class WorkgroupInvitation {
}
/**
- * @return the session id associated with the pending chat; working backwards temporally,
+ * Get the session id.
+ * @return the session id associated with the pending chat; working backwards temporally
* this session id should match the session id to the corresponding offer request
* which resulted in this invitation.
*/
@@ -96,6 +99,7 @@ public class WorkgroupInvitation {
}
/**
+ * Get the group chat name.
* @return the jid of the room to which the person is invited.
*/
public Jid getGroupChatName () {
@@ -103,6 +107,7 @@ public class WorkgroupInvitation {
}
/**
+ * Get workgroup name.
* @return the name of the workgroup from which the invitation was issued.
*/
public Jid getWorkgroupName () {
@@ -110,6 +115,7 @@ public class WorkgroupInvitation {
}
/**
+ * Get the message body.
* @return the contents of the body-block of the message that housed this invitation.
*/
public String getMessageBody () {
@@ -117,6 +123,7 @@ public class WorkgroupInvitation {
}
/**
+ * Get invitation sender.
* @return the user who issued the invitation, or null if it wasn't known.
*/
public Jid getInvitationSender () {
@@ -124,6 +131,7 @@ public class WorkgroupInvitation {
}
/**
+ * Get meta data.
* @return the meta data associated with the invitation, or null if this instance was
* constructed with none
*/
diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/Agent.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/Agent.java
index 5370bc14e..6dee818d1 100644
--- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/Agent.java
+++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/Agent.java
@@ -53,7 +53,7 @@ public class Agent {
}
/**
- * Return the agents JID
+ * Return the agents JID.
*
* @return - the agents JID.
*/
diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentRosterListener.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentRosterListener.java
index d9efa7912..ba589a01a 100644
--- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentRosterListener.java
+++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentRosterListener.java
@@ -20,7 +20,7 @@ package org.jivesoftware.smackx.workgroup.agent;
import org.jivesoftware.smack.packet.Presence;
/**
- *
+ * Agent roster listener.
* @author Matt Tucker
*/
public interface AgentRosterListener {
diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java
index cac54c12a..46c5b6753 100644
--- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java
+++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java
@@ -170,7 +170,7 @@ public class AgentSession {
}
/**
- * Returns the agent roster for the workgroup, which contains
+ * Returns the agent roster for the workgroup, which contains.
*
* @return the AgentRoster
* @throws NotConnectedException
@@ -554,6 +554,7 @@ public class AgentSession {
}
/**
+ * Get workgroup JID.
* @return the fully-qualified name of the workgroup for which this session exists
*/
public Jid getWorkgroupJID() {
@@ -570,6 +571,8 @@ public class AgentSession {
}
/**
+ * Get queue.
+ *
* @param queueName the name of the queue
* @return an instance of WorkgroupQueue for the argument queue name, or null if none exists
*/
diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/RevokedOffer.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/RevokedOffer.java
index 2c9e7ce79..159d264cf 100644
--- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/RevokedOffer.java
+++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/RevokedOffer.java
@@ -62,6 +62,7 @@ public class RevokedOffer {
}
/**
+ * Get user id.
* @return the jid of the user for which this revocation was issued
*/
public Jid getUserID() {
@@ -69,6 +70,7 @@ public class RevokedOffer {
}
/**
+ * Get workgroup name.
* @return the fully qualified name of the workgroup
*/
public Jid getWorkgroupName() {
@@ -76,6 +78,7 @@ public class RevokedOffer {
}
/**
+ * Get the sesion id.
* @return the session id which will associate all packets for the pending chat
*/
public String getSessionID() {
@@ -83,6 +86,7 @@ public class RevokedOffer {
}
/**
+ * Get reason.
* @return the server issued message as to why this revocation was issued
*/
public String getReason() {
@@ -90,6 +94,7 @@ public class RevokedOffer {
}
/**
+ * Get the timestamp.
* @return the timestamp at which the revocation was issued
*/
public Date getTimestamp() {
diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/MetaDataProvider.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/MetaDataProvider.java
index c9b6f8fc2..516e6a4cf 100644
--- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/MetaDataProvider.java
+++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/MetaDataProvider.java
@@ -35,7 +35,7 @@ import org.xmlpull.v1.XmlPullParserException;
public class MetaDataProvider extends ExtensionElementProvider {
/**
- * PacketExtensionProvider implementation
+ * PacketExtensionProvider implementation.
* @throws IOException
* @throws XmlPullParserException
*/
diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/WorkgroupInformation.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/WorkgroupInformation.java
index 08869e762..3d8837c53 100644
--- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/WorkgroupInformation.java
+++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/WorkgroupInformation.java
@@ -71,7 +71,7 @@ public class WorkgroupInformation implements ExtensionElement {
public static class Provider extends ExtensionElementProvider {
/**
- * PacketExtensionProvider implementation
+ * PacketExtensionProvider implementation.
* @throws IOException
* @throws XmlPullParserException
*/
diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java
index 7ed4a7029..97565db8a 100644
--- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java
+++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java
@@ -712,7 +712,7 @@ public class Workgroup {
}
/**
- * Asks the workgroup for it's Properties
+ * Asks the workgroup for it's Properties.
*
* @return the WorkgroupProperties for the specified workgroup.
* @throws XMPPErrorException
@@ -731,7 +731,7 @@ public class Workgroup {
}
/**
- * Asks the workgroup for it's Properties
+ * Asks the workgroup for it's Properties.
*
* @param jid the jid of the user who's information you would like the workgroup to retreive.
* @return the WorkgroupProperties for the specified workgroup.
diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/util/ListenerEventDispatcher.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/util/ListenerEventDispatcher.java
index 40bea535d..979423330 100644
--- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/util/ListenerEventDispatcher.java
+++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/util/ListenerEventDispatcher.java
@@ -77,6 +77,7 @@ public class ListenerEventDispatcher implements Runnable {
}
/**
+ * Has finished.
* @return whether this instance has finished dispatching its messages
*/
public boolean hasFinished() {
diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/xevent/MessageEventManager.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/xevent/MessageEventManager.java
index c7e67c1a5..3594c9ddc 100644
--- a/smack-legacy/src/main/java/org/jivesoftware/smackx/xevent/MessageEventManager.java
+++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/xevent/MessageEventManager.java
@@ -204,7 +204,7 @@ public class MessageEventManager extends Manager {
}
/**
- * Sends the notification that the message was delivered to the sender of the original message
+ * Sends the notification that the message was delivered to the sender of the original message.
*
* @param to the recipient of the notification.
* @param packetID the id of the message to send.
@@ -224,7 +224,7 @@ public class MessageEventManager extends Manager {
}
/**
- * Sends the notification that the message was displayed to the sender of the original message
+ * Sends the notification that the message was displayed to the sender of the original message.
*
* @param to the recipient of the notification.
* @param packetID the id of the message to send.
@@ -244,7 +244,7 @@ public class MessageEventManager extends Manager {
}
/**
- * Sends the notification that the receiver of the message is composing a reply
+ * Sends the notification that the receiver of the message is composing a reply.
*
* @param to the recipient of the notification.
* @param packetID the id of the message to send.
diff --git a/smack-sasl-javax/src/main/java/org/jivesoftware/smack/sasl/javax/SASLCramMD5Mechanism.java b/smack-sasl-javax/src/main/java/org/jivesoftware/smack/sasl/javax/SASLCramMD5Mechanism.java
index f6822e30a..25aded104 100644
--- a/smack-sasl-javax/src/main/java/org/jivesoftware/smack/sasl/javax/SASLCramMD5Mechanism.java
+++ b/smack-sasl-javax/src/main/java/org/jivesoftware/smack/sasl/javax/SASLCramMD5Mechanism.java
@@ -17,7 +17,7 @@
package org.jivesoftware.smack.sasl.javax;
/**
- * Implementation of the SASL CRAM-MD5 mechanism
+ * Implementation of the SASL CRAM-MD5 mechanism.
*
* @author Jay Kline
*/
diff --git a/smack-sasl-javax/src/main/java/org/jivesoftware/smack/sasl/javax/SASLDigestMD5Mechanism.java b/smack-sasl-javax/src/main/java/org/jivesoftware/smack/sasl/javax/SASLDigestMD5Mechanism.java
index c4959807b..d7038e6ea 100644
--- a/smack-sasl-javax/src/main/java/org/jivesoftware/smack/sasl/javax/SASLDigestMD5Mechanism.java
+++ b/smack-sasl-javax/src/main/java/org/jivesoftware/smack/sasl/javax/SASLDigestMD5Mechanism.java
@@ -17,7 +17,7 @@
package org.jivesoftware.smack.sasl.javax;
/**
- * Implementation of the SASL DIGEST-MD5 mechanism
+ * Implementation of the SASL DIGEST-MD5 mechanism.
*
* @author Jay Kline
*/
diff --git a/smack-sasl-javax/src/main/java/org/jivesoftware/smack/sasl/javax/SASLGSSAPIMechanism.java b/smack-sasl-javax/src/main/java/org/jivesoftware/smack/sasl/javax/SASLGSSAPIMechanism.java
index ae45cbd47..2a95dd8eb 100644
--- a/smack-sasl-javax/src/main/java/org/jivesoftware/smack/sasl/javax/SASLGSSAPIMechanism.java
+++ b/smack-sasl-javax/src/main/java/org/jivesoftware/smack/sasl/javax/SASLGSSAPIMechanism.java
@@ -21,7 +21,7 @@ import java.util.Map;
import javax.security.sasl.Sasl;
/**
- * Implementation of the SASL GSSAPI mechanism
+ * Implementation of the SASL GSSAPI mechanism.
*
* @author Jay Kline
*/
diff --git a/smack-sasl-javax/src/main/java/org/jivesoftware/smack/sasl/javax/SASLPlainMechanism.java b/smack-sasl-javax/src/main/java/org/jivesoftware/smack/sasl/javax/SASLPlainMechanism.java
index 4f02de9c0..83ee3e437 100644
--- a/smack-sasl-javax/src/main/java/org/jivesoftware/smack/sasl/javax/SASLPlainMechanism.java
+++ b/smack-sasl-javax/src/main/java/org/jivesoftware/smack/sasl/javax/SASLPlainMechanism.java
@@ -17,7 +17,7 @@
package org.jivesoftware.smack.sasl.javax;
/**
- * Implementation of the SASL PLAIN mechanism
+ * Implementation of the SASL PLAIN mechanism.
*
* @author Jay Kline
*/
diff --git a/smack-sasl-provided/src/main/java/org/jivesoftware/smack/sasl/provided/SASLExternalMechanism.java b/smack-sasl-provided/src/main/java/org/jivesoftware/smack/sasl/provided/SASLExternalMechanism.java
index d8997789b..3f6670f49 100644
--- a/smack-sasl-provided/src/main/java/org/jivesoftware/smack/sasl/provided/SASLExternalMechanism.java
+++ b/smack-sasl-provided/src/main/java/org/jivesoftware/smack/sasl/provided/SASLExternalMechanism.java
@@ -24,7 +24,7 @@ import org.jivesoftware.smack.util.StringUtils;
import org.jxmpp.util.XmppStringUtils;
/**
- * Implementation of the SASL-EXTERNAL authentication mechanism
+ * Implementation of the SASL-EXTERNAL authentication mechanism.
*
* @author Daniele Ricci
*/
diff --git a/smack-tcp/src/main/java/org/jivesoftware/smack/sm/SMUtils.java b/smack-tcp/src/main/java/org/jivesoftware/smack/sm/SMUtils.java
index d688a3bff..ac79f118b 100644
--- a/smack-tcp/src/main/java/org/jivesoftware/smack/sm/SMUtils.java
+++ b/smack-tcp/src/main/java/org/jivesoftware/smack/sm/SMUtils.java
@@ -23,6 +23,8 @@ public class SMUtils {
private static long MASK_32_BIT = BigInteger.ONE.shiftLeft(32).subtract(BigInteger.ONE).longValue();
/**
+ * Increment the Stream Management height counter.
+ *
* Quoting XEP-198 4.:
* "In the unlikely case that the number of stanzas handled during a stream management session exceeds the number
* of digits that can be represented by the unsignedInt datatype as specified in XML Schema Part 2 [10]