Enable javadoc checkstyle

and fix violations.

config/checkstyle.xml

@@ -75,5 +75,20 @@
 			<property name="message" value="Usage of println"/>
 			<property name="ignoreComments" value="true"/>
 		</module>
+		<module name="JavadocMethod">
+			<!-- TODO stricten those checks -->
+			<property name="scope" value="public"/>
+			<property name="allowUndeclaredRTE" value="true"/>
+			<property name="allowMissingParamTags" value="true"/>
+			<property name="allowMissingThrowsTags" value="true"/>
+			<property name="allowMissingReturnTag" value="true"/>
+			<property name="allowMissingJavadoc" value="true"/>
+			<property name="suppressLoadErrors" value="true"/>
+		</module>
+		<module name="JavadocStyle">
+			<property name="scope" value="public"/>
+			<property name="checkEmptyJavadoc" value="true"/>
+			<property name="checkHtml" value="false"/>
+		</module>
 	</module>
 </module>

smack-android/src/main/java/org/jivesoftware/smack/util/stringencoder/android/AndroidBase64Encoder.java

@@ -19,7 +19,7 @@ package org.jivesoftware.smack.util.stringencoder.android;
 import android.util.Base64;
 
 /**
- * A Base 64 encoding implementation based on android.util.Base64
+ * A Base 64 encoding implementation based on android.util.Base64.
  * @author Florian Schmaus
  */
 public class AndroidBase64Encoder implements org.jivesoftware.smack.util.stringencoder.Base64.Encoder {

smack-android/src/main/java/org/jivesoftware/smack/util/stringencoder/android/AndroidBase64UrlSafeEncoder.java

@@ -23,10 +23,6 @@ import org.jivesoftware.smack.util.stringencoder.StringEncoder;
 
 import android.util.Base64;
 
-
-/**
- * 
- */
 public class AndroidBase64UrlSafeEncoder implements StringEncoder {
 
     private static AndroidBase64UrlSafeEncoder instance = new AndroidBase64UrlSafeEncoder();

smack-core/src/main/java/org/jivesoftware/smack/AbstractConnectionClosedListener.java

@@ -16,9 +16,6 @@
  */
 package org.jivesoftware.smack;
 
-/**
- * 
- */
 public abstract class AbstractConnectionClosedListener extends AbstractConnectionListener {
 
     @Override

smack-core/src/main/java/org/jivesoftware/smack/AbstractXMPPConnection.java

@@ -47,7 +47,6 @@ import org.jivesoftware.smack.SmackException.AlreadyConnectedException;
 import org.jivesoftware.smack.SmackException.AlreadyLoggedInException;
 import org.jivesoftware.smack.SmackException.NoResponseException;
 import org.jivesoftware.smack.SmackException.NotConnectedException;
-import org.jivesoftware.smack.SmackException.ConnectionException;
 import org.jivesoftware.smack.SmackException.ResourceBindingNotOfferedException;
 import org.jivesoftware.smack.SmackException.SecurityRequiredException;
 import org.jivesoftware.smack.XMPPException.StreamErrorException;
@@ -342,7 +341,6 @@ public abstract class AbstractXMPPConnection implements XMPPConnection {
      * @throws XMPPException if an error occurs on the XMPP protocol level.
      * @throws SmackException if an error occurs somewhere else besides XMPP protocol level.
      * @throws IOException 
-     * @throws ConnectionException with detailed information about the failed connection.
      * @return a reference to this object, to chain <code>connect()</code> with <code>login()</code>.
      * @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
      */

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.

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);
 }

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

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);
 }

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,
         ;

smack-core/src/main/java/org/jivesoftware/smack/SASLAuthentication.java

@@ -65,7 +65,7 @@ public class SASLAuthentication {
     private static final Set<String> BLACKLISTED_MECHANISMS = new HashSet<String>();
 
     /**
-     * Registers a new SASL mechanism
+     * Registers a new SASL mechanism.
      *
      * @param mechanism a SASLMechanism subclass.
      */

smack-core/src/main/java/org/jivesoftware/smack/SmackConfiguration.java

@@ -175,6 +175,8 @@ public final class SmackConfiguration {
     }
 
     /**
+     * Get the debugger factory.
+     *
      * @return a debugger factory or <code>null</code>
      */
     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

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<? extends SmackDebugger> 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")

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 {
 
     /**

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 {
 
 

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 FlexibleStanzaTypeFilter<Message> {
 

smack-core/src/main/java/org/jivesoftware/smack/filter/MessageWithSubjectFilter.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 MessageWithSubjectFilter extends FlexibleStanzaTypeFilter<Message> {
 

smack-core/src/main/java/org/jivesoftware/smack/packet/Packet.java

@@ -39,7 +39,7 @@ public interface Packet extends TopLevelStreamElement {
     public String getStanzaId();
 
     /**
-     * 
+     * Get the stanza id.
      * @return the stanza id.
      * @deprecated use {@link #getStanzaId()} instead.
      */
@@ -55,7 +55,7 @@ public interface Packet extends TopLevelStreamElement {
     public void setStanzaId(String id);
 
     /**
-     * 
+     * Set the stanza ID.
      * @param packetID
      * @deprecated use {@link #setStanzaId(String)} instead.
      */

smack-core/src/main/java/org/jivesoftware/smack/packet/Presence.java

@@ -304,7 +304,7 @@ public final class Presence extends Stanza implements TypedCloneable<Presence> {
         error,
 
         /**
-         * A presence probe as defined in section 4.3 of RFC 6121
+         * A presence probe as defined in section 4.3 of RFC 6121.
          */
         probe,
         ;

smack-core/src/main/java/org/jivesoftware/smack/packet/Stanza.java

@@ -105,7 +105,7 @@ public abstract class Stanza implements TopLevelStreamElement {
     }
 
     /**
-     * 
+     * Get the Stanza ID.
      * @return the stanza id.
      * @deprecated use {@link #getStanzaId()} instead.
      */
@@ -128,7 +128,7 @@ public abstract class Stanza implements TopLevelStreamElement {
     }
 
     /**
-     * 
+     * Set the stanza ID.
      * @param packetID
      * @deprecated use {@link #setStanzaId(String)} instead.
      */

smack-core/src/main/java/org/jivesoftware/smack/packet/StreamError.java

@@ -149,7 +149,7 @@ public class StreamError extends AbstractError implements PlainStreamElement {
     }
 
     /**
-     * The defined stream error conditions, see RFC 6120 § 4.9.3
+     * The defined stream error conditions, see RFC 6120 § 4.9.3.
      *
      */
     public enum Condition {

smack-core/src/main/java/org/jivesoftware/smack/packet/StreamOpen.java

@@ -21,7 +21,7 @@ import org.jivesoftware.smack.util.StringUtils;
 import org.jivesoftware.smack.util.XmlStringBuilder;
 
 /**
- * 
+ * The stream open <b>tag</b>.
  */
 public class StreamOpen extends FullStreamElement {
 
@@ -31,32 +31,32 @@ public class StreamOpen extends FullStreamElement {
     public static final String SERVER_NAMESPACE = "jabber:server";
 
     /**
-     * RFC 6120 § 4.7.5
+     * RFC 6120 § 4.7.5.
      */
     public static final String VERSION = "1.0";
 
     /**
-     * RFC 6120 § 4.7.1
+     * RFC 6120 § 4.7.1.
      */
     private final String from;
 
     /**
-     * RFC 6120 § 4.7.2
+     * RFC 6120 § 4.7.2.
      */
     private final String to;
 
     /**
-     * RFC 6120 § 4.7.3
+     * RFC 6120 § 4.7.3.
      */
     private final String id;
 
     /**
-     * RFC 6120 § 4.7.4
+     * RFC 6120 § 4.7.4.
      */
     private final String lang;
 
     /**
-     * RFC 6120 § 4.8.2
+     * RFC 6120 § 4.8.2.
      */
     private final String contentNamespace;
 

smack-core/src/main/java/org/jivesoftware/smack/parsing/UnparsablePacket.java

@@ -34,7 +34,7 @@ public class UnparsablePacket {
     }
 
     /**
-     * 
+     * Get the exception that caused the parser to fail.
      * @return the exception that caused the parser to fail
      */
     public Exception getParsingException() {
@@ -42,7 +42,7 @@ public class UnparsablePacket {
     }
 
     /**
-     * Retrieve the raw stanza data
+     * Retrieve the raw stanza data.
      * 
      * @return the raw stanza data
      */

smack-core/src/main/java/org/jivesoftware/smack/provider/StreamFeatureProviderInfo.java

@@ -18,9 +18,6 @@ package org.jivesoftware.smack.provider;
 
 import org.jivesoftware.smack.packet.ExtensionElement;
 
-/**
- *
- */
 public final class StreamFeatureProviderInfo extends AbstractProviderInfo {
 
     /**

smack-core/src/main/java/org/jivesoftware/smack/proxy/Socks4ProxySocketFactory.java

@@ -26,7 +26,7 @@ import java.net.UnknownHostException;
 import javax.net.SocketFactory;
 
 /**
- * Socket factory for socks4 proxy 
+ * Socket factory for socks4 proxy.
  *  
  * @author Atul Aggarwal
  */

smack-core/src/main/java/org/jivesoftware/smack/proxy/Socks5ProxySocketFactory.java

@@ -25,7 +25,7 @@ import java.net.UnknownHostException;
 import javax.net.SocketFactory;
 
 /**
- * Socket factory for Socks5 proxy
+ * Socket factory for Socks5 proxy.
  * 
  * @author Atul Aggarwal
  */

smack-core/src/main/java/org/jivesoftware/smack/sasl/SASLAnonymous.java

@@ -21,7 +21,7 @@ import org.jivesoftware.smack.SmackException;
 import javax.security.auth.callback.CallbackHandler;
 
 /**
- * Implementation of the SASL ANONYMOUS mechanism
+ * Implementation of the SASL ANONYMOUS mechanism.
  *
  * @author Jay Kline
  */

smack-core/src/main/java/org/jivesoftware/smack/sasl/packet/SaslStreamElements.java

@@ -122,7 +122,7 @@ public class SaslStreamElements {
         final private String data;
 
         /**
-         * Construct a new SASL success stream element with optional additional data for the SASL layer
+         * Construct a new SASL success stream element with optional additional data for the SASL layer.
          * (RFC6120 6.3.10)
          * 
          * @param data additional data for the SASL layer or <code>null</code>
@@ -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 <a href="http://xmpp.org/rfcs/rfc6120.html#sasl-errors">RFC 6120 6.5 SASL Errors</a>
      */
     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() {

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

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 Exception
-     * @throws IOException 
-     * @throws SmackException 
      */
     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

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

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

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

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 <a href="http://tools.ietf.org/html/rfc2782">RFC 2782: A DNS RR for specifying the location of services (DNS
  * SRV)</a>
  * @author Florian Schmaus
@@ -28,7 +30,7 @@ public class SRVRecord extends HostAddress implements Comparable<SRVRecord> {
     private int priority;
 
     /**
-     * Create a new SRVRecord
+     * SRV Record constructor.
      * 
      * @param fqdn Fully qualified domain name
      * @param port The connection port

smack-core/src/main/java/org/jivesoftware/smack/util/stringencoder/StringEncoder.java

@@ -17,11 +17,13 @@
 package org.jivesoftware.smack.util.stringencoder;
 
 /**
+ * An interface for String encoder.
+ *
  * @author Florian Schmaus
  */
 public interface StringEncoder {
     /**
-     * Encodes an string to another representation
+     * Encodes an string to another representation.
      * 
      * @param string
      * @return the encoded String
@@ -29,7 +31,7 @@ public interface StringEncoder {
     String encode(String string);
 
     /**
-     * Decodes an string back to it's initial representation
+     * Decodes an string back to it's initial representation.
      * 
      * @param string
      * @return the decoded String

smack-core/src/test/java/org/jivesoftware/smack/ThreadedDummyConnection.java

@@ -30,7 +30,7 @@ import org.jivesoftware.smack.packet.Stanza;
 import org.jivesoftware.smack.packet.IQ.Type;
 
 /**
- * 
+ * A threaded dummy connection.
  * @author Robin Collier
  *
  */

smack-core/src/test/java/org/jivesoftware/smack/filters/FilterToStringTest.java

@@ -24,9 +24,6 @@ import org.jivesoftware.smack.filter.StanzaIdFilter;
 import org.jivesoftware.smack.filter.ThreadFilter;
 import org.junit.Test;
 
-/**
- * 
- */
 public class FilterToStringTest {
 
     @Test

smack-core/src/test/java/org/jivesoftware/smack/filters/FromMatchesFilterTest.java

@@ -27,7 +27,7 @@ import org.jxmpp.jid.Jid;
 import org.jxmpp.jid.JidTestUtil;
 
 /**
- * 
+ * From matches filter test.
  * @author Robin Collier
  *
  */

smack-core/src/test/java/org/jivesoftware/smack/packet/MessageTest.java

@@ -30,9 +30,6 @@ import java.util.Collection;
 import java.util.List;
 import java.util.ArrayList;
 
-/**
- *
- */
 public class MessageTest {
 
     @Test

smack-core/src/test/java/org/jivesoftware/smack/packet/PresenceTest.java

@@ -27,9 +27,6 @@ import org.xml.sax.SAXException;
 
 import java.io.IOException;
 
-/**
- *
- */
 public class PresenceTest {
     @Test
     public void setPresenceTypeTest() throws IOException, SAXException {

smack-core/src/test/java/org/jivesoftware/smack/util/PacketParserUtilsTest.java

@@ -47,9 +47,6 @@ import org.xmlpull.v1.XmlPullParserException;
 
 import com.jamesmurty.utils.XMLBuilder;
 
-/**
- *
- */
 public class PacketParserUtilsTest {
 
     private static Properties outputProperties = new Properties();

smack-debug-slf4j/src/main/java/org/jivesoftware/smackx/debugger/slf4j/SLF4JDebuggerFactory.java

@@ -25,7 +25,7 @@ import java.io.Reader;
 import java.io.Writer;
 
 /**
- * Implementation of SmackDebuggerFactory which always creates instance of SLF4JSmackDebugger
+ * Implementation of SmackDebuggerFactory which always creates instance of SLF4JSmackDebugger.
  */
 public class SLF4JDebuggerFactory implements SmackDebuggerFactory {
     @Override

smack-debug-slf4j/src/main/java/org/jivesoftware/smackx/debugger/slf4j/SLF4JSmackDebugger.java

@@ -55,14 +55,14 @@ public class SLF4JSmackDebugger implements SmackDebugger  {
     private ObservableReader reader;
 
     /**
-     * Makes Smack use this Debugger
+     * Makes Smack use this Debugger.
      */
     public static void enable() {
         SmackConfiguration.setDebuggerFactory(new SLF4JDebuggerFactory());
     }
 
     /**
-     * Create new SLF4J Smack Debugger instance
+     * Create new SLF4J Smack Debugger instance.
      * @param connection Smack connection to debug
      * @param writer connection data writer to observe
      * @param reader connection data reader to observe

smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/packet/Carbon.java

@@ -19,7 +19,7 @@ package org.jivesoftware.smackx.carbons.packet;
 import org.jivesoftware.smack.packet.SimpleIQ;
 
 /**
- * Carbon IQs
+ * Carbon IQs.
  */
 public class Carbon {
     public static final String NAMESPACE = "urn:xmpp:carbons:2";

smack-experimental/src/main/java/org/jivesoftware/smackx/csi/ClientStateIndicationManager.java

@@ -21,6 +21,7 @@ import org.jivesoftware.smack.XMPPConnection;
 import org.jivesoftware.smackx.csi.packet.ClientStateIndication;
 
 /**
+ * Manager for Client State Indication.
  *
  * @see <a href="http://xmpp.org/extensions/xep-0352.html">XEP-0352: Client State Indication</a>
  *

smack-experimental/src/main/java/org/jivesoftware/smackx/csi/packet/ClientStateIndication.java

@@ -20,7 +20,7 @@ import org.jivesoftware.smack.packet.FullStreamElement;
 import org.jivesoftware.smack.packet.ExtensionElement;
 
 /**
- * 
+ * Client State Indication.
  * @see <a href="http://xmpp.org/extensions/xep-0352.html">XEP-0352: Client State Indication</a>
  *
  */

smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/AbstractHttpOverXmpp.java

@@ -246,7 +246,7 @@ public abstract class AbstractHttpOverXmpp extends IQ {
         private final String text;
 
         /**
-         * Creates this element.builder.toString();
+         * Creates this element.builder.toString().
          *
          * @param text value of text
          */

smack-experimental/src/main/java/org/jivesoftware/smackx/json/packet/JsonPacketExtension.java

@@ -19,7 +19,7 @@ package org.jivesoftware.smackx.json.packet;
 import org.jivesoftware.smack.packet.Stanza;
 
 /**
- * XMPP JSON Containers as defined in XEP-0335
+ * XMPP JSON Containers as defined in XEP-0335.
  *
  * @see <a href="http://xmpp.org/extensions/xep-0335.html">XEP-0335: JSON Containers</a>
  */

smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPDeliverCondition.java

@@ -27,7 +27,7 @@ public class AMPDeliverCondition implements AMPExtension.Condition {
     public static final String NAME = "deliver";
 
     /**
-     * Check if server supports deliver condition
+     * Check if server supports deliver condition.
      * @param connection Smack connection instance
      * @return true if deliver condition is supported.
      * @throws XMPPErrorException 

smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPExpireAtCondition.java

@@ -31,7 +31,7 @@ public class AMPExpireAtCondition implements AMPExtension.Condition {
     public static final String NAME = "expire-at";
 
     /**
-     * Check if server supports expire-at condition
+     * Check if server supports expire-at condition.
      * @param connection Smack connection instance
      * @return true if expire-at condition is supported.
      * @throws XMPPErrorException 

smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPManager.java

@@ -79,7 +79,7 @@ public class AMPManager {
     }
 
     /**
-     * Check if server supports specified action
+     * Check if server supports specified action.
      * @param connection active xmpp connection
      * @param action action to check
      * @return true if this action is supported.
@@ -94,7 +94,7 @@ public class AMPManager {
     }
 
     /**
-     * Check if server supports specified condition
+     * Check if server supports specified condition.
      * @param connection active xmpp connection
      * @param conditionName name of condition to check
      * @return true if this condition is supported.

smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPMatchResourceCondition.java

@@ -27,7 +27,7 @@ public class AMPMatchResourceCondition implements AMPExtension.Condition {
     public static final String NAME = "match-resource";
 
     /**
-     * Check if server supports match-resource condition
+     * Check if server supports match-resource condition.
      * @param connection Smack connection instance
      * @return true if match-resource condition is supported.
      * @throws XMPPErrorException 
@@ -63,7 +63,7 @@ public class AMPMatchResourceCondition implements AMPExtension.Condition {
     }
 
     /**
-     * match-resource amp condition value as defined by XEP-0079
+     * match-resource amp condition value as defined by XEP-0079.
      * See http://xmpp.org/extensions/xep-0079.html#conditions-def-match
      */
     public static enum Value {

smack-extensions/src/main/java/org/jivesoftware/smackx/amp/packet/AMPExtension.java

@@ -59,6 +59,7 @@ public class AMPExtension implements ExtensionElement {
     }
 
     /**
+     * Get the JID that triggered this AMP callback.
      * @return jid that triggered this amp callback.
      */
     public String getFrom() {
@@ -66,6 +67,7 @@ public class AMPExtension implements ExtensionElement {
     }
 
     /**
+     * Get the receiver of this AMP receipt.
      * @return receiver of this amp receipt.
      */
     public String getTo() {
@@ -73,7 +75,7 @@ public class AMPExtension implements ExtensionElement {
     }
 
     /**
-     * Status of this amp notification
+     * Status of this amp notification.
      * @return Status for this amp
      */
     public Status getStatus() {
@@ -217,7 +219,7 @@ public class AMPExtension implements ExtensionElement {
     }
 
     /**
-     * Interface for defining XEP-0079 Conditions and their values
+     * Interface for defining XEP-0079 Conditions and their values.
      * @see AMPDeliverCondition
      * @see AMPExpireAtCondition
      * @see AMPMatchResourceCondition
@@ -230,7 +232,7 @@ public class AMPExtension implements ExtensionElement {
     }
 
     /**
-     * amp action attribute
+     * amp action attribute.
      * See http://xmpp.org/extensions/xep-0079.html#actions-def
      **/
     public static enum Action {
@@ -267,7 +269,7 @@ public class AMPExtension implements ExtensionElement {
     }
 
     /**
-     * amp notification status as defined by XEP-0079
+     * amp notification status as defined by XEP-0079.
      */
     public static enum Status {
         alert,

smack-extensions/src/main/java/org/jivesoftware/smackx/bookmarks/BookmarkManager.java

@@ -23,11 +23,9 @@ import java.util.List;
 import java.util.Map;
 import java.util.WeakHashMap;
 
-import org.jivesoftware.smack.SmackException;
 import org.jivesoftware.smack.SmackException.NoResponseException;
 import org.jivesoftware.smack.SmackException.NotConnectedException;
 import org.jivesoftware.smack.XMPPConnection;
-import org.jivesoftware.smack.XMPPException;
 import org.jivesoftware.smack.XMPPException.XMPPErrorException;
 import org.jivesoftware.smackx.iqprivate.PrivateDataManager;
 
@@ -56,12 +54,9 @@ public class BookmarkManager {
      * @param connection the connection for which the manager is desired.
      * @return Returns the <i>BookmarkManager</i> for a connection, if it doesn't
      * exist it is created.
-     * @throws XMPPException 
-     * @throws SmackException thrown has not been authenticated.
      * @throws IllegalArgumentException when the connection is null.
      */
     public synchronized static BookmarkManager getBookmarkManager(XMPPConnection connection)
-                    throws XMPPException, SmackException
     {
         BookmarkManager manager = bookmarkManagerMap.get(connection);
         if (manager == null) {

smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManager.java

@@ -128,7 +128,7 @@ public class InBandBytestreamManager implements BytestreamManager {
     }
 
     /**
-     * Maximum block size that is allowed for In-Band Bytestreams
+     * Maximum block size that is allowed for In-Band Bytestreams.
      */
     public static final int MAXIMUM_BLOCK_SIZE = 65535;
 

smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSession.java

@@ -818,6 +818,7 @@ public class InBandBytestreamSession implements BytestreamSession {
     }
 
     /**
+     * Process IQ stanza.
      * @param data
      * @throws NotConnectedException
      * @throws InterruptedException 

smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataPacketExtension.java

@@ -23,7 +23,7 @@ import org.jivesoftware.smack.util.stringencoder.Base64;
 
 /**
  * Represents a chunk of data of an In-Band Bytestream within an IQ stanza or a
- * message stanza
+ * message stanza.
  * 
  * @author Henning Staib
  */
@@ -35,7 +35,7 @@ public class DataPacketExtension implements ExtensionElement {
     public final static String ELEMENT = "data";
 
     /**
-     * The XMPP namespace of the In-Band Bytestream
+     * The XMPP namespace of the In-Band Bytestream.
      */
     public static final String NAMESPACE = "http://jabber.org/protocol/ibb";
 

smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/packet/Bytestream.java

@@ -35,7 +35,7 @@ public class Bytestream extends IQ {
     public static final String ELEMENT = QUERY_ELEMENT;
 
     /**
-     * The XMPP namespace of the SOCKS5 Bytestream
+     * The XMPP namespace of the SOCKS5 Bytestream.
      */
     public static final String NAMESPACE = "http://jabber.org/protocol/bytestreams";
 
@@ -50,7 +50,7 @@ public class Bytestream extends IQ {
     private Activate toActivate;
 
     /**
-     * The default constructor
+     * The default constructor.
      */
     public Bytestream() {
         super(ELEMENT, NAMESPACE);

smack-extensions/src/main/java/org/jivesoftware/smackx/caps/EntityCapsManager.java

@@ -127,7 +127,7 @@ public class EntityCapsManager extends Manager {
     }
 
     /**
-     * Set the default entity node that will be used for new EntityCapsManagers
+     * Set the default entity node that will be used for new EntityCapsManagers.
      *
      * @param entityNode
      */
@@ -217,7 +217,7 @@ public class EntityCapsManager extends Manager {
     }
 
     /**
-     * Set the persistent cache implementation
+     * Set the persistent cache implementation.
      * 
      * @param cache
      */
@@ -226,7 +226,7 @@ public class EntityCapsManager extends Manager {
     }
 
     /**
-     * Sets the maximum cache sizes
+     * Sets the maximum cache sizes.
      *
      * @param maxJidToNodeVerSize
      * @param maxCapsCacheSize
@@ -433,7 +433,7 @@ public class EntityCapsManager extends Manager {
     }
 
     /**
-     * Returns true if Entity Caps are supported by a given JID
+     * Returns true if Entity Caps are supported by a given JID.
      * 
      * @param jid
      * @return true if the entity supports Entity Capabilities.
@@ -447,7 +447,7 @@ public class EntityCapsManager extends Manager {
     }
 
     /**
-     * Returns true if Entity Caps are supported by the local service/server
+     * Returns true if Entity Caps are supported by the local service/server.
      * 
      * @return true if the user's server supports Entity Capabilities.
      * @throws XMPPErrorException 
@@ -524,7 +524,7 @@ public class EntityCapsManager extends Manager {
 
     /**
      * Verify DisoverInfo and Caps Node as defined in XEP-0115 5.4 Processing
-     * Method
+     * Method.
      * 
      * @see <a href="http://xmpp.org/extensions/xep-0115.html#ver-proc">XEP-0115
      *      5.4 Processing Method</a>

smack-extensions/src/main/java/org/jivesoftware/smackx/caps/cache/EntityCapsPersistentCache.java

@@ -20,7 +20,7 @@ import org.jivesoftware.smackx.disco.packet.DiscoverInfo;
 
 public interface EntityCapsPersistentCache {
     /**
-     * Add an DiscoverInfo to the persistent Cache
+     * Add an DiscoverInfo to the persistent Cache.
      * 
      * @param nodeVer
      * @param info
@@ -28,12 +28,12 @@ public interface EntityCapsPersistentCache {
     void addDiscoverInfoByNodePersistent(String nodeVer, DiscoverInfo info);
 
     /**
-     * Lookup DiscoverInfo by a Node string
+     * Lookup DiscoverInfo by a Node string.
      */
     DiscoverInfo lookup(String nodeVer);
 
     /**
-     * Empty the Cache
+     * Empty the Cache.
      */
     void emptyCache();
 }

smack-extensions/src/main/java/org/jivesoftware/smackx/caps/packet/CapsExtension.java

@@ -56,6 +56,8 @@ public class CapsExtension implements ExtensionElement {
     }
 
     /**
+     * {@inheritDoc}.
+     *
      * <pre>
      *  <c xmlns='http://jabber.org/protocol/caps'
      *     hash='sha-1'

smack-extensions/src/main/java/org/jivesoftware/smackx/commands/packet/AdHocCommandData.java

@@ -124,7 +124,7 @@ public class AdHocCommandData extends IQ {
     }
 
     /**
-     * Returns the human name of the command
+     * Returns the human name of the command.
      *
      * @return the name of the command.
      */
@@ -137,7 +137,7 @@ public class AdHocCommandData extends IQ {
     }
 
     /**
-     * Returns the identifier of the command
+     * Returns the identifier of the command.
      *
      * @return the node.
      */

smack-extensions/src/main/java/org/jivesoftware/smackx/delay/DelayInformationManager.java

@@ -23,7 +23,7 @@ import org.jivesoftware.smack.packet.ExtensionElement;
 import org.jivesoftware.smackx.delay.packet.DelayInformation;
 
 /**
- * Delayed Delivery (XEP-203)
+ * Delayed Delivery (XEP-203).
  *
  * @author Florian Schmaus
  * @see <a href="http://xmpp.org/extensions/xep-0203.html">Delayed Delivery (XEP-203)</a>
@@ -75,7 +75,7 @@ public class DelayInformationManager {
     }
 
     /**
-     * Get the Delayed Delivery timestamp or <code>null</code>
+     * Get the Delayed Delivery timestamp or <code>null</code>.
      *
      * @param packet
      * @return the Delayed Delivery timestamp or <code>null</code>

smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java

@@ -108,6 +108,7 @@ public class DelayInformation implements ExtensionElement {
     }
 
     /**
+     * Return delay information from the given stanza.
      *
      * @param packet
      * @return the DelayInformation or null
@@ -119,6 +120,7 @@ public class DelayInformation implements ExtensionElement {
     }
 
     /**
+     * Return delay information from the given stanza.
      *
      * @param packet
      * @return the DelayInformation or null

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<DiscoverItems.Item> getNodeItems() {

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 <a href="http://xmpp.org/extensions/xep-0128.html">XEP-128: Service Discovery Extensions</a>
      * @return the data form

smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfo.java

@@ -56,7 +56,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable<DiscoverInfo> {
     }
 
     /**
-     * Copy constructor
+     * Copy constructor.
      * 
      * @param d
      */
@@ -128,7 +128,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable<DiscoverInfo> {
     }
 
     /**
-     * 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<DiscoverInfo> {
         }
 
         /**
-         * 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<DiscoverInfo> {
         /** 
          * Check equality for Identity  for category, type, lang and name
          * in that order as defined by
-         * <a href="http://xmpp.org/extensions/xep-0115.html#ver-proc">XEP-0015 5.4 Processing Method (Step 3.3)</a>
+         * <a href="http://xmpp.org/extensions/xep-0115.html#ver-proc">XEP-0015 5.4 Processing Method (Step 3.3)</a>.
          *  
          */
         public boolean equals(Object obj) {

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.");
 

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.

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
      */

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

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
      */

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 <a href="http://xmpp.org/extensions/xep-0045.html#affil">XEP-0045: Multi-User-Chat - 5.2 Affiliations</a>
  */

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 <a href="http://xmpp.org/extensions/xep-0045.html#roles">XEP-0045: Multi-User-Chat - 5.1 Roles</a>
  */

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
      */

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

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<ExtensionElement> {
      *
      * @param parser the XML parser, positioned at the starting element of the extension.
      * @return a PacketExtension.
-     * @throws IOException 
+     * @throws Exception 
-     * @throws XmlPullParserException 
-     * @throws SmackException 
      */
     @Override
     public ExtensionElement parse(XmlPullParser parser, int initialDepth)

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
      */

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
      */

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 <a href="http://xmpp.org/extensions/xep-0060.html#registrar-formtypes-config">16.4.3</a>
+ * as defined in the pubsub specification section <a href="http://xmpp.org/extensions/xep-0060.html#registrar-formtypes-config">16.4.3</a>.
  * 
  * @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;
 }

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 <a href="http://xmpp.org/extensions/xep-0060.html#registrar-formtypes-config">16.4.3</a>
+ * with collection nodes as defined in the pubsub specification section <a href="http://xmpp.org/extensions/xep-0060.html#registrar-formtypes-config">16.4.3</a>.
  * 
  * @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. */

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
 	 */

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.
 	 * 
 	 * <p><b>Value: {@link AccessModel}</b></p>
 	 */
@@ -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.
 	 * 
 	 * <p><b>Value: {@link URL}</b></p>
 	 */
 	body_xslt,
 
 	/**
-	 * The collection with which a node is affiliated
+	 * The collection with which a node is affiliated.
 	 * 
 	 * <p><b>Value: String</b></p>
 	 */
@@ -63,21 +63,21 @@ public enum ConfigureNodeFields
 	dataform_xslt,
 
 	/**
-	 * Whether to deliver payloads with event notifications
+	 * Whether to deliver payloads with event notifications.
 	 *
 	 * <p><b>Value: boolean</b></p>
 	 */
 	deliver_payloads,
 
 	/**
-	 * Whether owners or publisher should receive replies to items
+	 * Whether owners or publisher should receive replies to items.
 	 *
 	 * <p><b>Value: {@link ItemReply}</b></p>
 	 */
 	itemreply,
 
 	/**
-	 * Who may associate leaf nodes with a collection
+	 * Who may associate leaf nodes with a collection.
 	 * 
 	 * <p><b>Value: {@link ChildrenAssociationPolicy}</b></p>
 	 */
@@ -85,14 +85,14 @@ public enum ConfigureNodeFields
 
 	/**
 	 * The list of JIDs that may associate leaf nodes with a 
-	 * collection
+	 * collection.
 	 * 
 	 * <p><b>Value: List of JIDs as Strings</b></p>
 	 */
 	children_association_whitelist,
 
 	/**
-	 * The child nodes (leaf or collection) associated with a collection
+	 * The child nodes (leaf or collection) associated with a collection.
 	 * 
 	 * <p><b>Value: List of Strings</b></p>
 	 */
@@ -100,56 +100,56 @@ public enum ConfigureNodeFields
 
 	/**
 	 * The maximum number of child nodes that can be associated with a 
-	 * collection
+	 * collection.
 	 * 
 	 * <p><b>Value: int</b></p>
 	 */
 	children_max,
 
 	/**
-	 * The maximum number of items to persist
+	 * The maximum number of items to persist.
 	 * 
 	 * <p><b>Value: int</b></p>
 	 */
 	max_items,
 
 	/**
-	 * The maximum payload size in bytes
+	 * The maximum payload size in bytes.
 	 * 
 	 * <p><b>Value: int</b></p>
 	 */
 	max_payload_size,
 
 	/**
-	 * Whether the node is a leaf (default) or collection
+	 * Whether the node is a leaf (default) or collection.
 	 * 
 	 * <p><b>Value: {@link NodeType}</b></p>
 	 */
 	node_type,
 
 	/**
-	 * Whether to notify subscribers when the node configuration changes
+	 * Whether to notify subscribers when the node configuration changes.
 	 * 
 	 * <p><b>Value: boolean</b></p>
 	 */
 	notify_config,
 
 	/**
-	 * Whether to notify subscribers when the node is deleted
+	 * Whether to notify subscribers when the node is deleted.
 	 * 
 	 * <p><b>Value: boolean</b></p>
 	 */
 	notify_delete,
 
 	/**
-	 * Whether to notify subscribers when items are removed from the node
+	 * Whether to notify subscribers when items are removed from the node.
 	 * 
 	 * <p><b>Value: boolean</b></p>
 	 */
 	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. 
 	 * 
 	 * <p><b>Value: boolean</b></p>
@@ -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.
 	 * 
 	 * <p><b>Value: boolean</b></p>
 	 */
 	presence_based_delivery,
 
 	/**
-	 * Defines who can publish to the node
+	 * Defines who can publish to the node.
 	 * 
 	 * <p><b>Value: {@link PublishModel}</b></p>
 	 */
 	publish_model,
 
 	/**
-	 * The specific multi-user chat rooms to specify for replyroom
+	 * The specific multi-user chat rooms to specify for replyroom.
 	 * 
 	 * <p><b>Value: List of JIDs as Strings</b></p>
 	 */
 	replyroom,
 
 	/**
-	 * The specific JID(s) to specify for replyto
+	 * The specific JID(s) to specify for replyto.
 	 * 
 	 * <p><b>Value: List of JIDs as Strings</b></p>
 	 */
 	replyto,
 
 	/**
-	 * The roster group(s) allowed to subscribe and retrieve items
+	 * The roster group(s) allowed to subscribe and retrieve items.
 	 * 
 	 * <p><b>Value: List of strings</b></p>
 	 */
 	roster_groups_allowed,
 
 	/**
-	 * Whether to allow subscriptions
+	 * Whether to allow subscriptions.
 	 * 
 	 * <p><b>Value: boolean</b></p>
 	 */
 	subscribe,
 
 	/**
-	 * A friendly name for the node
+	 * A friendly name for the node.
 	 * 
 	 * <p><b>Value: String</b></p>
 	 */
@@ -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.
 	 * 
 	 * <p><b>Value: String</b></p>
 	 */

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
 }

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()

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;
 }

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 <b>max_items</b> attribute when requesting items */
+		/** An items element, which has an optional <b>max_items</b> attribute when requesting items. */
 		items(PubSubElementType.ITEMS, "max_items"),
 
-		/** A retract element, which has an optional <b>notify</b> attribute when publishing deletions */
+		/** A retract element, which has an optional <b>notify</b> 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
 	 */

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 

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
 	 */

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
  */

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 

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;
 }

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
 	 */

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.
 	 * 
 	 * <p><b>Value: boolean</b></p>
 	 */
@@ -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.
 	 * 
 	 * <p><b>Value: int</b></p>
 	 */
 	digest_frequency,
 
 	/**
-	 * 
+	 * Expire.
 	 * <p><b>Value: {@link Calendar}</b></p>
 	 */
 	expire,
@@ -70,13 +70,14 @@ public enum SubscribeOptionFields
 	show_values,
 
 	/**
-	 * 
+	 * Subscription type.
 	 * 
 	 * <p><b>Value: </b></p>
 	 */
 	subscription_type,
 
 	/**
+	 * Subscription depth.
 	 *
 	 * <p><b>Value: </b></p>
 	 */

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
 	 */

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscriptionsExtension.java

@@ -29,7 +29,7 @@ public class SubscriptionsExtension extends NodeExtension
 	protected List<Subscription> items = Collections.emptyList();
 
 	/**
-	 * Subscriptions to the root node
+	 * Subscriptions to the root node.
 	 * 
 	 * @param subList The list of subscriptions
 	 */

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

smack-extensions/src/main/java/org/jivesoftware/smackx/search/ReportedData.java

@@ -99,7 +99,7 @@ public class ReportedData {
     }
 
     /**
-     * Adds a new <code>Column</code>
+     * Adds a new <code>Column</code>.
      * @param column the column to add.
      */
     public void addColumn(Column column){

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 <code>ReportedData</code>
+     * in the form of <code>ReportedData</code>.
      *
      * @param searchForm    the <code>Form</code> to submit for searching.
      * @param searchService the name of the search service to use.

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 <b>Header</b> entry as specified by the <a href="http://xmpp.org/extensions/xep-031.html">Stanza Headers and Internet Metadata (SHIM)</a>
+ * Represents a <b>Header</b> entry as specified by the <a href="http://xmpp.org/extensions/xep-031.html">Stanza Headers and Internet Metadata (SHIM)</a>.
 
  * @author Robin Collier
  */