From efcca7d0628c1c5f52c44da152c3da6b68317e2f Mon Sep 17 00:00:00 2001 From: Pascal Schumacher Date: Fri, 22 May 2020 10:49:39 +0200 Subject: [PATCH] Fix javadoc warnings related to non-existing parameter names. --- .../activemq/broker/region/policy/PolicyEntry.java | 2 +- .../store/MessageStoreSubscriptionStatistics.java | 4 ---- .../main/java/org/apache/activemq/ActiveMQSession.java | 9 --------- .../java/org/apache/activemq/transport/LogWriter.java | 4 ++-- .../activemq/transport/discovery/DiscoveryAgent.java | 3 +-- .../transport/failover/FailoverTransportFactory.java | 2 +- .../activemq/transport/mock/MockTransportFactory.java | 2 +- .../apache/activemq/transport/tcp/ResponseHolder.java | 2 +- .../activemq/store/kahadb/disk/index/HashIndex.java | 9 ++++----- .../activemq/ra/ActiveMQConnectionRequestInfo.java | 4 ---- 10 files changed, 11 insertions(+), 30 deletions(-) diff --git a/activemq-broker/src/main/java/org/apache/activemq/broker/region/policy/PolicyEntry.java b/activemq-broker/src/main/java/org/apache/activemq/broker/region/policy/PolicyEntry.java index 164b98463a..ab869b0b2c 100644 --- a/activemq-broker/src/main/java/org/apache/activemq/broker/region/policy/PolicyEntry.java +++ b/activemq-broker/src/main/java/org/apache/activemq/broker/region/policy/PolicyEntry.java @@ -1037,7 +1037,7 @@ public class PolicyEntry extends DestinationMapEntry { /** * Sets the amount of time a destination is inactive before it is marked for GC * - * @param inactiveTimoutBeforeGC + * @param inactiveTimeoutBeforeGC * time in milliseconds to configure as the inactive timeout. */ public void setInactiveTimeoutBeforeGC(long inactiveTimeoutBeforeGC) { diff --git a/activemq-broker/src/main/java/org/apache/activemq/store/MessageStoreSubscriptionStatistics.java b/activemq-broker/src/main/java/org/apache/activemq/store/MessageStoreSubscriptionStatistics.java index d246957308..8be581cc61 100644 --- a/activemq-broker/src/main/java/org/apache/activemq/store/MessageStoreSubscriptionStatistics.java +++ b/activemq-broker/src/main/java/org/apache/activemq/store/MessageStoreSubscriptionStatistics.java @@ -30,8 +30,6 @@ public class MessageStoreSubscriptionStatistics extends AbstractMessageStoreStat /** * @param enabled - * @param countDescription - * @param sizeDescription */ public MessageStoreSubscriptionStatistics(boolean enabled) { super(enabled, "The number of messages or this subscription in the message store", @@ -99,8 +97,6 @@ public class MessageStoreSubscriptionStatistics extends AbstractMessageStoreStat /** * @param enabled - * @param countDescription - * @param sizeDescription */ public SubscriptionStatistics(boolean enabled) { super(enabled, "The number of messages or this subscription in the message store", diff --git a/activemq-client/src/main/java/org/apache/activemq/ActiveMQSession.java b/activemq-client/src/main/java/org/apache/activemq/ActiveMQSession.java index 8afb442d08..73c161671e 100644 --- a/activemq-client/src/main/java/org/apache/activemq/ActiveMQSession.java +++ b/activemq-client/src/main/java/org/apache/activemq/ActiveMQSession.java @@ -1382,15 +1382,6 @@ public class ActiveMQSession implements Session, QueueSession, TopicSession, Sta return new ActiveMQTopic(topicName); } - /** - * Creates a QueueBrowser object to peek at the messages on - * the specified queue. - * - * @param queue the queue to access - * @exception InvalidDestinationException if an invalid destination is - * specified - * @since 1.1 - */ /** * Creates a durable subscriber to the specified topic. *

diff --git a/activemq-client/src/main/java/org/apache/activemq/transport/LogWriter.java b/activemq-client/src/main/java/org/apache/activemq/transport/LogWriter.java index d92ccc6fb6..aa101381ed 100644 --- a/activemq-client/src/main/java/org/apache/activemq/transport/LogWriter.java +++ b/activemq-client/src/main/java/org/apache/activemq/transport/LogWriter.java @@ -59,7 +59,7 @@ public interface LogWriter { * @param log The log to be written to. * @param command The command to be logged. */ - public void logResponse (Logger log, Object response); + public void logResponse (Logger log, Object command); /** * Writes a message to a log when an asynchronous equest command is sent. @@ -85,7 +85,7 @@ public interface LogWriter { /** * Writes a message to a log when an exception is received. * @param log The log to be written to. - * @param command The command to be logged. + * @param error The exception to be logged. */ public void logReceivedException (Logger log, IOException error); diff --git a/activemq-client/src/main/java/org/apache/activemq/transport/discovery/DiscoveryAgent.java b/activemq-client/src/main/java/org/apache/activemq/transport/discovery/DiscoveryAgent.java index 65a6ab5393..99c2e80ea0 100644 --- a/activemq-client/src/main/java/org/apache/activemq/transport/discovery/DiscoveryAgent.java +++ b/activemq-client/src/main/java/org/apache/activemq/transport/discovery/DiscoveryAgent.java @@ -41,8 +41,7 @@ public interface DiscoveryAgent extends Service { /** * register a service * @param name - * @param details - * @throws JMSException + * @throws IOException */ void registerService(String name) throws IOException; diff --git a/activemq-client/src/main/java/org/apache/activemq/transport/failover/FailoverTransportFactory.java b/activemq-client/src/main/java/org/apache/activemq/transport/failover/FailoverTransportFactory.java index c2778cebd3..91310c5a92 100644 --- a/activemq-client/src/main/java/org/apache/activemq/transport/failover/FailoverTransportFactory.java +++ b/activemq-client/src/main/java/org/apache/activemq/transport/failover/FailoverTransportFactory.java @@ -54,7 +54,7 @@ public class FailoverTransportFactory extends TransportFactory { } /** - * @param location + * @param compositData * @return * @throws IOException */ diff --git a/activemq-client/src/main/java/org/apache/activemq/transport/mock/MockTransportFactory.java b/activemq-client/src/main/java/org/apache/activemq/transport/mock/MockTransportFactory.java index 3e147d0e35..9a4b37671f 100644 --- a/activemq-client/src/main/java/org/apache/activemq/transport/mock/MockTransportFactory.java +++ b/activemq-client/src/main/java/org/apache/activemq/transport/mock/MockTransportFactory.java @@ -45,7 +45,7 @@ public class MockTransportFactory extends TransportFactory { } /** - * @param location + * @param compositData * @return a new Transport instance. * @throws Exception */ diff --git a/activemq-client/src/main/java/org/apache/activemq/transport/tcp/ResponseHolder.java b/activemq-client/src/main/java/org/apache/activemq/transport/tcp/ResponseHolder.java index 77458264d5..5290981904 100644 --- a/activemq-client/src/main/java/org/apache/activemq/transport/tcp/ResponseHolder.java +++ b/activemq-client/src/main/java/org/apache/activemq/transport/tcp/ResponseHolder.java @@ -35,7 +35,7 @@ public class ResponseHolder { /** * Set the Response for this holder * - * @param response + * @param r * the response returned from the remote peer. */ public void setResponse(Response r) { diff --git a/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/disk/index/HashIndex.java b/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/disk/index/HashIndex.java index df7078eca5..d64c41625b 100644 --- a/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/disk/index/HashIndex.java +++ b/activemq-kahadb-store/src/main/java/org/apache/activemq/store/kahadb/disk/index/HashIndex.java @@ -129,10 +129,8 @@ public class HashIndex implements Index { /** * Constructor * - * @param directory - * @param name - * @param indexManager - * @param numberOfBins + * @param pageFile + * @param pageId * @throws IOException */ public HashIndex(PageFile pageFile, long pageId) throws IOException { @@ -399,10 +397,11 @@ public class HashIndex implements Index { public Marshaller getValueMarshaller() { return valueMarshaller; } + /** * Set the marshaller for value objects * - * @param marshaller + * @param valueMarshaller */ public void setValueMarshaller(Marshaller valueMarshaller) { this.valueMarshaller = valueMarshaller; diff --git a/activemq-ra/src/main/java/org/apache/activemq/ra/ActiveMQConnectionRequestInfo.java b/activemq-ra/src/main/java/org/apache/activemq/ra/ActiveMQConnectionRequestInfo.java index 5086b415c1..3f3bc0ae3f 100644 --- a/activemq-ra/src/main/java/org/apache/activemq/ra/ActiveMQConnectionRequestInfo.java +++ b/activemq-ra/src/main/java/org/apache/activemq/ra/ActiveMQConnectionRequestInfo.java @@ -160,10 +160,6 @@ public class ActiveMQConnectionRequestInfo implements ConnectionRequestInfo, Ser return true; } - /** - * @param i - * @return - */ private boolean notEqual(Object o1, Object o2) { return (o1 == null ^ o2 == null) || (o1 != null && !o1.equals(o2)); }