Enable javadoc checkstyle

and fix violations.

smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/MetaData.java

@@ -46,6 +46,7 @@ public class MetaData implements ExtensionElement {
     }
 
     /**
+     * Get meta data.
      * @return the Map of metadata contained by this instance
      */
     public Map<String, List<String>> getMetaData() {

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

smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/WorkgroupInvitation.java

@@ -40,7 +40,7 @@ public class WorkgroupInvitation {
     protected Map<String, List<String>> 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
      */

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

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 {

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

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

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<MetaData> {
 
     /**
-     * PacketExtensionProvider implementation
+     * PacketExtensionProvider implementation.
      * @throws IOException 
      * @throws XmlPullParserException 
      */

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<WorkgroupInformation> {
 
         /**
-         * PacketExtensionProvider implementation
+         * PacketExtensionProvider implementation.
          * @throws IOException 
          * @throws XmlPullParserException 
          */

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.

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

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.