Enable javadoc checkstyle

and fix violations.

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,14 +70,15 @@ public enum SubscribeOptionFields
 	show_values,
 
 	/**
-	 * 
+	 * Subscription type.
 	 * 
 	 * <p><b>Value: </b></p>
 	 */
 	subscription_type,
 
 	/**
-	 * 
+	 * Subscription depth.
+	 *
 	 * <p><b>Value: </b></p>
 	 */
 	subscription_depth;

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