Enable werror for javadoc and fix javadoc issues

smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferListener.java

@@ -26,7 +26,7 @@ public interface FileTransferListener {
     /**
      * A request to send a file has been received from another user.
      *
-     * @param request
+     * @param request TODO javadoc me please
      *            The request from the other user.
      */
     void fileTransferRequest(FileTransferRequest request);

smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferManager.java

@@ -65,7 +65,7 @@ public final class FileTransferManager extends Manager {
     /**
      * Creates a file transfer manager to initiate and receive file transfers.
      *
-     * @param connection
+     * @param connection TODO javadoc me please
      *            The XMPPConnection that the file transfers will use.
      */
     private FileTransferManager(XMPPConnection connection) {
@@ -90,7 +90,7 @@ public final class FileTransferManager extends Manager {
      * Add a file transfer listener to listen to incoming file transfer
      * requests.
      *
-     * @param li
+     * @param li TODO javadoc me please
      *            The listener
      * @see #removeFileTransferListener(FileTransferListener)
      * @see FileTransferListener
@@ -102,7 +102,7 @@ public final class FileTransferManager extends Manager {
     /**
      * Removes a file transfer listener.
      *
-     * @param li
+     * @param li TODO javadoc me please
      *            The file transfer listener to be removed
      * @see FileTransferListener
      */
@@ -113,7 +113,7 @@ public final class FileTransferManager extends Manager {
     /**
      * Creates an OutgoingFileTransfer to send a file to another user.
      *
-     * @param userID
+     * @param userID TODO javadoc me please
      *            The fully qualified jabber ID (i.e. full JID) with resource of the user to
      *            send the file to.
      * @return The send file object on which the negotiated transfer can be run.
@@ -137,7 +137,7 @@ public final class FileTransferManager extends Manager {
      * invoked. It will create an IncomingFileTransfer which allows the
      * transmission of the file to proceed.
      *
-     * @param request
+     * @param request TODO javadoc me please
      *            The remote request that is being accepted.
      * @return The IncomingFileTransfer which manages the download of the file
      *         from the transfer initiator.
@@ -160,9 +160,9 @@ public final class FileTransferManager extends Manager {
      * <p>
      * Specified in XEP-95 4.2 and 3.2 Example 8
      * </p>
-     * @param request
-     * @throws NotConnectedException
-     * @throws InterruptedException
+     * @param request TODO javadoc me please
+     * @throws NotConnectedException if the XMPP connection is not connected.
+     * @throws InterruptedException if the calling thread was interrupted.
      */
     protected void rejectIncomingFileTransfer(FileTransferRequest request) throws NotConnectedException, InterruptedException {
         StreamInitiation initiation = request.getStreamInitiation();

smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferNegotiator.java

@@ -182,9 +182,9 @@ public final class FileTransferNegotiator extends Manager {
      * @return The file transfer object that handles the transfer
      * @throws NoStreamMethodsOfferedException If there are either no stream methods contained in the packet, or
      *                       there is not an appropriate stream method.
-     * @throws NotConnectedException
-     * @throws NoAcceptableTransferMechanisms
-     * @throws InterruptedException
+     * @throws NotConnectedException if the XMPP connection is not connected.
+     * @throws NoAcceptableTransferMechanisms if no acceptable transfer mechanisms are available
+     * @throws InterruptedException if the calling thread was interrupted.
      */
     public StreamNegotiator selectStreamNegotiator(
             FileTransferRequest request) throws NotConnectedException, NoStreamMethodsOfferedException, NoAcceptableTransferMechanisms, InterruptedException {
@@ -296,10 +296,10 @@ public final class FileTransferNegotiator extends Manager {
      *                        user to respond. If they do not respond in time, this
      * @return Returns the stream negotiator selected by the peer.
      * @throws XMPPErrorException Thrown if there is an error negotiating the file transfer.
-     * @throws NotConnectedException
-     * @throws NoResponseException
-     * @throws NoAcceptableTransferMechanisms
-     * @throws InterruptedException
+     * @throws NotConnectedException if the XMPP connection is not connected.
+     * @throws NoResponseException if there was no response from the remote entity.
+     * @throws NoAcceptableTransferMechanisms if no acceptable transfer mechanisms are available
+     * @throws InterruptedException if the calling thread was interrupted.
      */
     public StreamNegotiator negotiateOutgoingTransfer(final Jid userID,
             final String streamID, final String fileName, final long size,

smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferRequest.java

@@ -37,10 +37,10 @@ public class FileTransferRequest {
      * A receive request is constructed from the Stream Initiation request
      * received from the initiator.
      *
-     * @param manager
+     * @param manager TODO javadoc me please
      *            The manager handling this file transfer
      *
-     * @param si
+     * @param si TODO javadoc me please
      *            The Stream initiation received from the initiator.
      */
     public FileTransferRequest(FileTransferManager manager, StreamInitiation si) {
@@ -131,8 +131,8 @@ public class FileTransferRequest {
 
     /**
      * Rejects the file transfer request.
-     * @throws NotConnectedException
-     * @throws InterruptedException
+     * @throws NotConnectedException if the XMPP connection is not connected.
+     * @throws InterruptedException if the calling thread was interrupted.
      */
     public void reject() throws NotConnectedException, InterruptedException {
         manager.rejectIncomingFileTransfer(this);

smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/IncomingFileTransfer.java

@@ -74,10 +74,10 @@ public class IncomingFileTransfer extends FileTransfer {
      * the negotiated stream.
      *
      * @return The negotiated InputStream from which to read the data.
-     * @throws SmackException
+     * @throws SmackException if Smack detected an exceptional situation.
      * @throws XMPPErrorException If there is an error in the negotiation process an exception
      *                       is thrown.
-     * @throws InterruptedException
+     * @throws InterruptedException if the calling thread was interrupted.
      */
     public InputStream receiveFile() throws SmackException, XMPPErrorException, InterruptedException {
         if (inputStream != null) {
@@ -110,7 +110,7 @@ public class IncomingFileTransfer extends FileTransfer {
      *
      * @param file The location to save the file.
      * @throws SmackException when the file transfer fails
-     * @throws IOException
+     * @throws IOException if an I/O error occured.
      * @throws IllegalArgumentException This exception is thrown when the the provided file is
      *         either null, or cannot be written to.
      */

smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/OutgoingFileTransfer.java

@@ -63,7 +63,7 @@ public class OutgoingFileTransfer extends FileTransfer {
      * Sets the time in milliseconds after which the file transfer negotiation
      * process will timeout if the other user has not responded.
      *
-     * @param responseTimeout
+     * @param responseTimeout TODO javadoc me please
      *            The timeout time in milliseconds.
      */
     public static void setResponseTimeout(int responseTimeout) {
@@ -108,21 +108,21 @@ public class OutgoingFileTransfer extends FileTransfer {
      * This method handles the negotiation of the file transfer and the stream,
      * it only returns the created stream after the negotiation has been completed.
      *
-     * @param fileName
+     * @param fileName TODO javadoc me please
      *            The name of the file that will be transmitted. It is
      *            preferable for this name to have an extension as it will be
      *            used to determine the type of file it is.
-     * @param fileSize
+     * @param fileSize TODO javadoc me please
      *            The size in bytes of the file that will be transmitted.
-     * @param description
+     * @param description TODO javadoc me please
      *            A description of the file that will be transmitted.
      * @return The OutputStream that is connected to the peer to transmit the
      *         file.
-     * @throws XMPPException
+     * @throws XMPPException if an XMPP protocol error was received.
      *             Thrown if an error occurs during the file transfer
      *             negotiation process.
      * @throws SmackException if there was no response from the server.
-     * @throws InterruptedException
+     * @throws InterruptedException if the calling thread was interrupted.
      */
     public synchronized OutputStream sendFile(String fileName, long fileSize,
             String description) throws XMPPException, SmackException, InterruptedException {
@@ -146,15 +146,15 @@ public class OutgoingFileTransfer extends FileTransfer {
      * returns immediately and its progress will be updated through the
      * {@link NegotiationProgress} callback.
      *
-     * @param fileName
+     * @param fileName TODO javadoc me please
      *            The name of the file that will be transmitted. It is
      *            preferable for this name to have an extension as it will be
      *            used to determine the type of file it is.
-     * @param fileSize
+     * @param fileSize TODO javadoc me please
      *            The size in bytes of the file that will be transmitted.
-     * @param description
+     * @param description TODO javadoc me please
      *            A description of the file that will be transmitted.
-     * @param progress
+     * @param progress TODO javadoc me please
      *            A callback to monitor the progress of the file transfer
      *            negotiation process and to retrieve the OutputStream when it
      *            is complete.
@@ -212,7 +212,7 @@ public class OutgoingFileTransfer extends FileTransfer {
      *
      * @param file the file to transfer to the remote entity.
      * @param description a description for the file to transfer.
-     * @throws SmackException
+     * @throws SmackException if Smack detected an exceptional situation.
      *             If there is an error during the negotiation process or the
      *             sending of the file.
      */

smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/StreamNegotiator.java

@@ -152,7 +152,7 @@ public abstract class StreamNegotiator extends Manager {
      * @throws XMPPErrorException If an error occurs during this process an XMPPException is
      *                       thrown.
      * @throws InterruptedException If thread is interrupted.
-     * @throws SmackException
+     * @throws SmackException if Smack detected an exceptional situation.
      */
     public abstract InputStream createIncomingStream(StreamInitiation initiation)
             throws XMPPErrorException, InterruptedException, SmackException;
@@ -168,9 +168,9 @@ public abstract class StreamNegotiator extends Manager {
      * @param target    The fully-qualified JID of the target or receiver of the file
      *                  transfer.
      * @return The negotiated stream ready for data.
-     * @throws SmackException
-     * @throws XMPPException
-     * @throws InterruptedException
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws XMPPException if an XMPP protocol error was received.
+     * @throws InterruptedException if the calling thread was interrupted.
      */
     public abstract OutputStream createOutgoingStream(String streamID,
             Jid initiator, Jid target) throws SmackException, XMPPException, InterruptedException;