From 65342a5ad2d25b39b4aa0868d073c2f5b24d2abb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ville=20Skytt=C3=A4?= Date: Sun, 9 Oct 2016 17:39:29 +0300 Subject: [PATCH] javadoc: Fix doclint syntax errors --- .../activemq/artemis/junit/ThreadLeakCheckRule.java | 2 +- .../core/config/storage/DatabaseStorageConfiguration.java | 4 ++-- .../activemq/artemis/core/paging/PagingManager.java | 2 +- .../apache/activemq/transport/amqp/client/AmqpClient.java | 8 ++++---- .../activemq/transport/amqp/client/sasl/Mechanism.java | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/ThreadLeakCheckRule.java b/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/ThreadLeakCheckRule.java index d3c6bee387..62b14357ec 100644 --- a/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/ThreadLeakCheckRule.java +++ b/artemis-junit/src/main/java/org/apache/activemq/artemis/junit/ThreadLeakCheckRule.java @@ -52,7 +52,7 @@ public class ThreadLeakCheckRule extends ExternalResource { /** * Override to set up your specific external resource. * - * @throws if setup fails (which will disable {@code after} + * @throws Throwable if setup fails (which will disable {@code after}) */ @Override protected void before() throws Throwable { diff --git a/artemis-server/src/main/java/org/apache/activemq/artemis/core/config/storage/DatabaseStorageConfiguration.java b/artemis-server/src/main/java/org/apache/activemq/artemis/core/config/storage/DatabaseStorageConfiguration.java index ffeb708359..8b20770b64 100644 --- a/artemis-server/src/main/java/org/apache/activemq/artemis/core/config/storage/DatabaseStorageConfiguration.java +++ b/artemis-server/src/main/java/org/apache/activemq/artemis/core/config/storage/DatabaseStorageConfiguration.java @@ -103,8 +103,8 @@ public class DatabaseStorageConfiguration implements StoreConfiguration { /** * The {@link SQLProvider.Factory} used to communicate with the JDBC data store. - * It can be {@code null}. If the value is {@code null} and {@code dataSource} is set, the {@code {@link org.apache.activemq.artemis.jdbc.store.sql.GenericSQLProvider.Factory} will be user, - * else the type of the factory will be determined based on the {@code jdbcDriverClassName). + * It can be {@code null}. If the value is {@code null} and {@code dataSource} is set, the {@code {@link org.apache.activemq.artemis.jdbc.store.sql.GenericSQLProvider.Factory}} will be used, + * else the type of the factory will be determined based on the {@code jdbcDriverClassName}. * * @return the factory used to communicate with the JDBC data store. */ diff --git a/artemis-server/src/main/java/org/apache/activemq/artemis/core/paging/PagingManager.java b/artemis-server/src/main/java/org/apache/activemq/artemis/core/paging/PagingManager.java index 15b2701c3a..35d2235f45 100644 --- a/artemis-server/src/main/java/org/apache/activemq/artemis/core/paging/PagingManager.java +++ b/artemis-server/src/main/java/org/apache/activemq/artemis/core/paging/PagingManager.java @@ -97,7 +97,7 @@ public interface PagingManager extends ActiveMQComponent, HierarchicalRepository /** * Add size at the global count level. - * if totalSize > globalMaxSize it will return true + * if totalSize > globalMaxSize it will return true */ PagingManager addSize(int size); diff --git a/tests/artemis-test-support/src/main/java/org/apache/activemq/transport/amqp/client/AmqpClient.java b/tests/artemis-test-support/src/main/java/org/apache/activemq/transport/amqp/client/AmqpClient.java index 001942ed4e..56353e465b 100644 --- a/tests/artemis-test-support/src/main/java/org/apache/activemq/transport/amqp/client/AmqpClient.java +++ b/tests/artemis-test-support/src/main/java/org/apache/activemq/transport/amqp/client/AmqpClient.java @@ -63,7 +63,7 @@ public class AmqpClient { * connect attempt immediately and will fail if the remote peer cannot be reached. * * @throws Exception if an error occurs attempting to connect to the Broker. - * @returns a new connection object used to interact with the connected peer. + * @return a new connection object used to interact with the connected peer. */ public AmqpConnection connect() throws Exception { @@ -82,7 +82,7 @@ public class AmqpClient { * changes applied before the connect method is invoked. * * @throws Exception if an error occurs attempting to connect to the Broker. - * @returns a new connection object used to interact with the connected peer. + * @return a new connection object used to interact with the connected peer. */ public AmqpConnection createConnection() throws Exception { if (username == null && password != null) { @@ -218,7 +218,7 @@ public class AmqpClient { * * @param broker the address of the remote broker instance. * @throws Exception if an error occurs attempting to connect to the Broker. - * @returns a new connection object used to interact with the connected peer. + * @return a new connection object used to interact with the connected peer. */ public static AmqpConnection connect(URI broker) throws Exception { return connect(broker, null, null); @@ -231,7 +231,7 @@ public class AmqpClient { * @param username the user name to use to connect to the broker or null for anonymous. * @param password the password to use to connect to the broker, must be null if user name is null. * @throws Exception if an error occurs attempting to connect to the Broker. - * @returns a new connection object used to interact with the connected peer. + * @return a new connection object used to interact with the connected peer. */ public static AmqpConnection connect(URI broker, String username, String password) throws Exception { if (username == null && password != null) { diff --git a/tests/artemis-test-support/src/main/java/org/apache/activemq/transport/amqp/client/sasl/Mechanism.java b/tests/artemis-test-support/src/main/java/org/apache/activemq/transport/amqp/client/sasl/Mechanism.java index e7b2667214..0f2186dd05 100644 --- a/tests/artemis-test-support/src/main/java/org/apache/activemq/transport/amqp/client/sasl/Mechanism.java +++ b/tests/artemis-test-support/src/main/java/org/apache/activemq/transport/amqp/client/sasl/Mechanism.java @@ -103,7 +103,7 @@ public interface Mechanism extends Comparable { String getPassword(); /** - * Sets any additional Mechanism specific properties using a Map + * Sets any additional Mechanism specific properties using a Map<String, Object> * * @param options the map of additional properties that this Mechanism should utilize. */