Enable werror for javadoc and fix javadoc issues

2025-12-08 06:01:07 +01:00 · 2019-08-30 12:08:30 +02:00 · 2019-08-30 12:08:30 +02:00 · 1a3067c89b
commit 1a3067c89b
parent 4249c1a845
323 changed files with 2929 additions and 2704 deletions
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManagerTest.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManagerTest.java
@ -61,9 +61,9 @@ public class InBandBytestreamManagerTest extends InitExtensions {

    /**
     * Initialize fields used in the tests.
-     * @throws XMPPException
-     * @throws SmackException
-     * @throws InterruptedException
+     * @throws XMPPException if an XMPP protocol error was received.
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws InterruptedException if the calling thread was interrupted.
     */
    @Before
    public void setup() throws XMPPException, SmackException, InterruptedException {
@ -105,9 +105,9 @@ public class InBandBytestreamManagerTest extends InitExtensions {
     * Invoking {@link InBandBytestreamManager#establishSession(org.jxmpp.jid.Jid)} should
     * throw an exception if the given target does not support in-band
     * bytestream.
-     * @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.
     */
    @Test
    public void shouldFailIfTargetDoesNotSupportIBB() throws SmackException, XMPPException, InterruptedException {
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamRequestTest.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamRequestTest.java
@ -71,8 +71,8 @@ public class InBandBytestreamRequestTest extends InitExtensions {

    /**
     * Test reject() method.
-     * @throws NotConnectedException
-     * @throws InterruptedException
+     * @throws NotConnectedException if the XMPP connection is not connected.
+     * @throws InterruptedException if the calling thread was interrupted.
     */
    @Test
    public void shouldReplyWithErrorIfRequestIsRejected() throws NotConnectedException, InterruptedException {
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionMessageTest.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionMessageTest.java
@ -75,9 +75,9 @@ public class InBandBytestreamSessionMessageTest extends InitExtensions {

    /**
     * Initialize fields used in the tests.
-     * @throws XMPPException
-     * @throws SmackException
-     * @throws InterruptedException
+     * @throws XMPPException if an XMPP protocol error was received.
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws InterruptedException if the calling thread was interrupted.
     */
    @Before
    public void setup() throws XMPPException, SmackException, InterruptedException {
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionTest.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSessionTest.java
@ -76,9 +76,9 @@ public class InBandBytestreamSessionTest extends InitExtensions {

    /**
     * Initialize fields used in the tests.
-     * @throws XMPPException
-     * @throws SmackException
-     * @throws InterruptedException
+     * @throws XMPPException if an XMPP protocol error was received.
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws InterruptedException if the calling thread was interrupted.
     */
    @Before
    public void setup() throws XMPPException, SmackException, InterruptedException {
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamManagerTest.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamManagerTest.java
@ -109,9 +109,9 @@ public class Socks5ByteStreamManagerTest {
     * The SOCKS5 Bytestream feature should be removed form the service discovery manager if Socks5
     * bytestream feature is disabled.
     *
-     * @throws InterruptedException
-     * @throws SmackException
-     * @throws XMPPErrorException
+     * @throws InterruptedException if the calling thread was interrupted.
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws XMPPErrorException if there was an XMPP error returned.
     */
    @Test
    public void shouldDisableService() throws XMPPErrorException, SmackException, InterruptedException {
@ -131,10 +131,10 @@ public class Socks5ByteStreamManagerTest {
    /**
     * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid)} should throw an exception
     * if the given target does not support SOCKS5 Bytestream.
-     * @throws XMPPException
-     * @throws InterruptedException
-     * @throws SmackException
-     * @throws IOException
+     * @throws XMPPException if an XMPP protocol error was received.
+     * @throws InterruptedException if the calling thread was interrupted.
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws IOException if an I/O error occured.
     */
    @Test
    public void shouldFailIfTargetDoesNotSupportSocks5()
@ -159,10 +159,10 @@ public class Socks5ByteStreamManagerTest {
    /**
     * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} should fail if XMPP
     * server doesn't return any proxies.
-     * @throws InterruptedException
-     * @throws SmackException
-     * @throws XMPPException
-     * @throws IOException
+     * @throws InterruptedException if the calling thread was interrupted.
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws XMPPException if an XMPP protocol error was received.
+     * @throws IOException if an I/O error occured.
     */
    @Test
    public void shouldFailIfNoSocks5ProxyFound1()
@ -211,10 +211,10 @@ public class Socks5ByteStreamManagerTest {
     * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} should fail if no
     * proxy is a SOCKS5 proxy.
     *
-     * @throws InterruptedException
-     * @throws SmackException
-     * @throws XMPPException
-     * @throws IOException
+     * @throws InterruptedException if the calling thread was interrupted.
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws XMPPException if an XMPP protocol error was received.
+     * @throws IOException if an I/O error occured.
     */
    @Test
    public void shouldFailIfNoSocks5ProxyFound2()
@ -273,10 +273,10 @@ public class Socks5ByteStreamManagerTest {
     * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} should fail if no
     * SOCKS5 proxy can be found. If it turns out that a proxy is not a SOCKS5 proxy it should not
     * be queried again.
-     * @throws InterruptedException
-     * @throws SmackException
-     * @throws XMPPException
-     * @throws IOException
+     * @throws InterruptedException if the calling thread was interrupted.
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws XMPPException if an XMPP protocol error was received.
+     * @throws IOException if an I/O error occured.
     */
    @Test
    public void shouldBlacklistNonSocks5Proxies() throws SmackException, InterruptedException, IOException, XMPPException {
@ -355,10 +355,10 @@ public class Socks5ByteStreamManagerTest {
     * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} should fail if the
     * target does not accept a SOCKS5 Bytestream. See <a
     * href="http://xmpp.org/extensions/xep-0065.html#usecase-alternate">XEP-0065 Section 5.2 A2</a>
-     * @throws InterruptedException
-     * @throws SmackException
-     * @throws XMPPException
-     * @throws IOException
+     * @throws InterruptedException if the calling thread was interrupted.
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws XMPPException if an XMPP protocol error was received.
+     * @throws IOException if an I/O error occured.
     */
    @Test
    public void shouldFailIfTargetDoesNotAcceptSocks5Bytestream() throws SmackException, InterruptedException, IOException, XMPPException {
@ -435,10 +435,10 @@ public class Socks5ByteStreamManagerTest {
     * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} should fail if the
     * proxy used by target is invalid.
     *
-     * @throws InterruptedException
-     * @throws SmackException
-     * @throws XMPPException
-     * @throws IOException
+     * @throws InterruptedException if the calling thread was interrupted.
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws XMPPException if an XMPP protocol error was received.
+     * @throws IOException if an I/O error occured.
     */
    @Test
    public void shouldFailIfTargetUsesInvalidSocks5Proxy()
@ -517,10 +517,10 @@ public class Socks5ByteStreamManagerTest {
     * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} should fail if
     * initiator can not connect to the SOCKS5 proxy used by target.
     *
-     * @throws InterruptedException
-     * @throws SmackException
-     * @throws XMPPException
-     * @throws XmppStringprepException
+     * @throws InterruptedException if the calling thread was interrupted.
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws XMPPException if an XMPP protocol error was received.
+     * @throws XmppStringprepException if the provided string is invalid.
     */
    @Test
    public void shouldFailIfInitiatorCannotConnectToSocks5Proxy()
@ -617,10 +617,10 @@ public class Socks5ByteStreamManagerTest {
     * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} should successfully
     * negotiate and return a SOCKS5 Bytestream connection.
     *
-     * @throws InterruptedException
-     * @throws SmackException
-     * @throws XMPPException
-     * @throws IOException
+     * @throws InterruptedException if the calling thread was interrupted.
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws XMPPException if an XMPP protocol error was received.
+     * @throws IOException if an I/O error occured.
     */
    @Test
    public void shouldNegotiateSocks5BytestreamAndTransferData()
@ -737,11 +737,11 @@ public class Socks5ByteStreamManagerTest {
     * If multiple network addresses are added to the local SOCKS5 proxy, all of them should be
     * contained in the SOCKS5 Bytestream request.
     *
-     * @throws InterruptedException
-     * @throws SmackException
-     * @throws IOException
-     * @throws XMPPException
-     * @throws TimeoutException
+     * @throws InterruptedException if the calling thread was interrupted.
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws IOException if an I/O error occured.
+     * @throws XMPPException if an XMPP protocol error was received.
+     * @throws TimeoutException if there was a timeout.
     */
    @Test
    public void shouldUseMultipleAddressesForLocalSocks5Proxy()
@ -843,10 +843,10 @@ public class Socks5ByteStreamManagerTest {
     * Invoking {@link Socks5BytestreamManager#establishSession(org.jxmpp.jid.Jid, String)} the first time
     * should successfully negotiate a SOCKS5 Bytestream via the second SOCKS5 proxy and should
     * prioritize this proxy for a second SOCKS5 Bytestream negotiation.
-     * @throws InterruptedException
-     * @throws SmackException
-     * @throws XMPPException
-     * @throws IOException
+     * @throws InterruptedException if the calling thread was interrupted.
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws XMPPException if an XMPP protocol error was received.
+     * @throws IOException if an I/O error occured.
     *
     */
    @Test
@ -932,10 +932,10 @@ public class Socks5ByteStreamManagerTest {
     * should successfully negotiate a SOCKS5 Bytestream via the second SOCKS5 proxy. The second
     * negotiation should run in the same manner if prioritization is disabled.
     *
-     * @throws IOException
-     * @throws InterruptedException
-     * @throws SmackException
-     * @throws XMPPException
+     * @throws IOException if an I/O error occured.
+     * @throws InterruptedException if the calling thread was interrupted.
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws XMPPException if an XMPP protocol error was received.
     *
     */
    @Test
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamRequestTest.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamRequestTest.java
@ -98,7 +98,7 @@ public class Socks5ByteStreamRequestTest {
     * Accepting a SOCKS5 Bytestream request should fail if target is not able to connect to any of
     * the provided SOCKS5 proxies.
     *
-     * @throws Exception
+     * @throws Exception if an exception occurs.
     */
    @Test
    public void shouldFailIfRequestHasInvalidStreamHosts() throws Exception {
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/caps/EntityCapsManagerTest.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/caps/EntityCapsManagerTest.java
@ -47,7 +47,7 @@ public class EntityCapsManagerTest extends InitExtensions {
    /**
     * <a href="http://xmpp.org/extensions/xep-0115.html#ver-gen-complex">XEP-
     * 0115 Complex Generation Example</a>.
-     * @throws XmppStringprepException
+     * @throws XmppStringprepException if the provided string is invalid.
     */
    @Test
    public void testComplexGenerationExample() throws XmppStringprepException {
--- a/smack-extensions/src/test/java/org/jivesoftware/smackx/ping/PingTest.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/smackx/ping/PingTest.java
@ -98,10 +98,10 @@ public class PingTest extends InitExtensions {

    /**
     * DummyConnection will not reply so it will timeout.
-     * @throws SmackException
-     * @throws XMPPException
-     * @throws IOException
-     * @throws InterruptedException
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws XMPPException if an XMPP protocol error was received.
+     * @throws IOException if an I/O error occured.
+     * @throws InterruptedException if the calling thread was interrupted.
     */
    @Test
    public void checkFailedPingOnTimeout() throws SmackException, IOException, XMPPException, InterruptedException {
@ -119,7 +119,7 @@ public class PingTest extends InitExtensions {

    /**
     * Server returns an exception for entity.
-     * @throws Exception
+     * @throws Exception if an exception occurs.
     */
    @Test
    public void checkFailedPingToEntityError() throws Exception {
@ -155,7 +155,7 @@ public class PingTest extends InitExtensions {

    /**
     * Server returns an exception.
-     * @throws Exception
+     * @throws Exception if an exception occurs.
     */
    @Test
    public void checkPingToServerError() throws Exception {
@ -243,10 +243,10 @@ public class PingTest extends InitExtensions {
     * The returned connection won't send replies to IQs
     *
     * @return
-     * @throws XMPPException
-     * @throws IOException
-     * @throws SmackException
-     * @throws InterruptedException
+     * @throws XMPPException if an XMPP protocol error was received.
+     * @throws IOException if an I/O error occured.
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws InterruptedException if the calling thread was interrupted.
     */
    private static DummyConnection getAuthenticatedDummyConnectionWithoutIqReplies() throws SmackException, IOException, XMPPException, InterruptedException {
        DummyConnection con = new DummyConnection();
--- a/smack-extensions/src/test/java/org/jivesoftware/util/ConnectionUtils.java
+++ b/smack-extensions/src/test/java/org/jivesoftware/util/ConnectionUtils.java
@ -64,9 +64,9 @@ public class ConnectionUtils {
     * @param protocol protocol helper containing answer packets
     * @param initiatorJID the user associated to the XMPP connection
     * @return a mocked XMPP connection
-     * @throws SmackException
-     * @throws XMPPErrorException
-     * @throws InterruptedException
+     * @throws SmackException if Smack detected an exceptional situation.
+     * @throws XMPPErrorException if there was an XMPP error returned.
+     * @throws InterruptedException if the calling thread was interrupted.
     */
    public static XMPPConnection createMockedConnection(final Protocol protocol,
                    EntityFullJid initiatorJID) throws SmackException, XMPPErrorException, InterruptedException {